A program to help build, maintain, and release PEP 517-compliant projects.
Includes a basic task runner, in the form of
bork run <task name>. Tasks
are defined in your
Bork requires Python 3.6 or newer.
$ pip3 install bork
Or download the latest zipapp releases
Downloading Existing Builds
To download a release from GitHub:
$ bork download gh:duckinator/emanate # download latest .pyz for Emanate $ bork download gh:duckinator/emanate --directory bin/ # put files in ./bin $ bork download gh:ppb/pursuedpybear --files '*.tar.gz' # download latest .tar.gz file
To download a wheel from a PyPi release:
$ bork download pypi:emanate 6.0.0 --files '*.whl'
To download a wheel from a release on PyPi's test instance:
$ bork download testpypi:whaledo 1.0.1 --files '*.whl'
Building and Releasing
Assuming a project is PEP 517 compliant, you can just do:
$ bork clean # Remove anything in build/, dist/, *.egg-info/ $ bork build # Build the project $ bork release # Release to PyPI
If you want to build a ZipApp, add this to your pyproject.toml:
[tool.bork.zipapp] enabled = true main = "<entrypoint>"
<entrypoint> is of the form "module.submodule:function", and
may be equivalent to a
console_script entrypoint in setup.cfg.
Bug reports and pull requests are welcome on GitHub at https://github.com/duckinator/bork. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The code for Bork is available under the MIT License.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.