Spinarak is a tool to generate a libget repo, given a set of pkgbuild files describing packages.
Developed internally by ForTheUsers (4TU) to power the Homebrew App Store, it is the successor to the original repogen.py script.
It is named after the beloved Pokémon Spinarak, as it performs the delicate task of wrapping together messy piles of homebrew into a neat web of packages.
It spins webs that are strong enough to withstand having stones set on them...
In short, Spinarak does the following:
- For each committed
pkgbuild.json:- Download non-local package assets
- Generate package metadata (
manifest.install,info.json) - Fetch statistics from 4TU's stats system
- Zip packages for distribution
- Generate the repository's index (
repo.json), listing all built packages
Generating a repository is simple:
Create a directory to serve as the build directory; then, create subdirectories named for each package within it. Each subdirectory must contain pkgbuild.json (TODO: create document describing this format) describing how the package should be built; it can also optionally contain local assets to be used during packaging.
Simply run python3 spinarak.py in the build directory. (TODO: dependencies, docker) Optionally, you can modify the sample config.json as you see fit; within it, you can change the output directory (out by default). You can also blacklist directories from being built as packages and set valid extensions for binary files. (If and only if the pkgbuild.json does not specify which file is the main binary of the package, Spinarak will use this list to detect valid binary files by their extension.) If a config.json is not present, Spinarak will use its default configuration.
A few notes about Spinarak's character and behavior:
- It's an observant little spider: it will auto-detect a previous libget repo in the output directory and update it.
- It's a lazy little spider: it will only update packages that have not changed.
- It's a responsible little spider: it will refuse to create a libget repo if the output directory isn't blank or nonexistent.
The output directory is now a complete libget repo, ready for static hosting! Use your favorite hosting tool - GitLab Pages works beautifully, for example.
- built packages include the pkgbuild, which isn't necessary
- stats API integration is completely missing
- Temp directories sometimes make it into the final zips by accident. (Maybe. Need to verify that this bug still happens.)
- Dockerize the crap out of this
- Link with stats API
Spinarak is licensed under....well, I haven't decided, yet. If you happen to use it before I properly license it, ping us over at https://discord.fortheusers.org.
Contributors:
- CompuCat - primary development
- vgmoose - Dockerization, integration with the Homebrew App Store
- crc32 and pwsincd - Referencing libget formatting
- Whovian9369 - Writing documentation
...and the rest of the 4TU team.