Bork Command Line Interface

A build and release tool for Python projects, with ZipApp support.

usage: bork [-h] [--version] [--verbose]
            {aliases,build,clean,download,release,run} ...

Named Arguments

--version

Print version information and exit.

Default: False

--verbose, --debug

Enable verbose logging.

Default: False

Sub-commands

aliases

Prints the aliases configured via pyproject.toml.

bork aliases [-h]

build

Build the project.

bork build [-h] [--zipapp] [--no-zipapp] [--zipapp-main ZIPAPP_MAIN]

Named Arguments

--zipapp

Always build a zipapp.

--no-zipapp

Never build to zipapp.

--zipapp-main

Entrypoint for the ZipApp. Format is: module.submodule:function

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] [--github] [--no-github] [--pypi] [--no-pypi]

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

--github

Release to GitHub, ignoring pyproject.toml.

--no-github

Don’t release to GitHub, ignoring pyproject.toml.

--pypi

Release to PyPi, ignoring pyproject.toml.

--no-pypi

Don’t release to GitHub, ignoring pyproject.toml.

run

Run the specified alias.

bork run [-h] ALIAS

Positional Arguments

ALIAS