Bork Command Line Interface
A build and release tool for Python projects, with ZipApp support.
usage: bork [-h] [--version] [--verbose] [--debug]
{aliases,build,clean,download,release,run} ...
Named Arguments
- --version
Print version information and exit.
Default: False
- --verbose
Enable verbose logging.
Default: False
- --debug
Enable VERY verbose logging. (Sometimes too noisy to be helpful.)
Default: False
Sub-commands
aliases
Prints the aliases configured via pyproject.toml.
bork aliases [-h]
build
Build the project.
bork build [-h]
clean
Remove files generated by bork build.
bork clean [-h]
download
Download a release of the specified project.
bork download [-h] [--files FILES] [--directory DIRECTORY] PACKAGE [RELEASE]
Positional Arguments
- PACKAGE
The package to download. Format: SOURCE:PACKAGE_NAME, where PACKAGE_NAME is the name of the package to download, and SOURCE is one of gh, github, pypi, or testpypi.
- RELEASE
The release or tag to download.
Default: “latest”
Named Arguments
- --files
Comma-separated list of filenames to download.Supports wildcards (* = everything, ? = any single character).
Default: “*.pyz”
- --directory
Directory to save files in. Created if missing. (Default: downloads)
Default: “downloads”
release
Publish a built project.
bork release [-h] [--pypi-repository PYPI_REPOSITORY] [--test-pypi]
[--dry-run]
Named Arguments
- --pypi-repository
Repository to use. Valid values are pypi, testpypi, or anything defined in ‘.pypirc’.
Default: “pypi”
- --test-pypi
Release to test.pypi.org instead of pypi.org. Equivalent to ‘–pypi-repository testpypi’.
Default: False
- --dry-run
Don’t actually release, just show what a release would do.
Default: False
run
Run the specified alias.
bork run [-h] ALIAS
Positional Arguments
- ALIAS