A program to help build, maintain, and release PEP 517-compliant projects.
Project description
bork
A frontend for building and releasing PEP 517 compliant projects, including support for generating a ZipApp.
Includes a basic task runner, in the form of bork run <task name>
. Tasks
are defined in your pyproject.toml
file.
Bork requires Python 3.6 or newer.
Installation
$ pip3 install bork
Or download the latest zipapp releases
Usage
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
ZipApp Support
If you want to build a ZipApp, add this to your pyproject.toml:
[tool.bork.zipapp]
enabled = true
main = "<entrypoint>"
Where <entrypoint>
is of the form "module.submodule:function", and
may be equivalent to a console_script
entrypoint in setup.cfg.
NOTE: ZipApps will only be compressed when using Python 3.7 and earlier. This means ZipApps created with older versions may be significantly larger.
Uploading To GitHub Releases
If you want to upload assets to GitHub Releases, you can add the following configuration to your pyproject.toml:
[tool.bork]
# GitHub Releases will have names that are "{project_name} {tag}".
# The default is the repository name -- e.g., if your repo is at "foo/bar-baz",
# the default would be "bar-baz".
# This lets you change that, so it looks nicer. (E.g., "Bar Baz".)
project_name = "<nicely formatted project name>"
[tool.bork.release]
# If true, release to PyPi; otherwise, don't.
pypi = true
# If true, release to GitHub; otherwise, don't.
github = true # release to GitHub
# GitHub repository, e.g. "duckinator/bork".
github_repository = "<owner>/<repo>"
# List of file globs to include in GitHub Releases.
github_release_globs = ["dist/*.pyz", "dist/*.whl"]
# If true, zipapps are named "<name>.pyz", otherwise "<name>-<version>.pyz".
strip_zipapp_version = true
Contributing
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.