Skip to main content

Kickoff

Kickoff turns your Python script or module into an application with decent user interface.

For software developers…

Kickoff is inspired by utilities like invoke, fire, runfile. It has similar function with this difference that it looks at function signatures, therefore doesn’t need from the developer to use decorators or any dedicated API. This way Kickoff provides developers with following advantages:

  • Basic UI provided with zero overhead

  • Enhanced UI provided through annotations

  • Compatibility with environments where Kickoff is not installed

  • Testability and reusability of top-level commands

  • Shebang support

For software users…

Kickoff is built on top of stunning click module as well as third-party add-ons to provide the users with following features:

  • Hierarchical CLI interface

  • Correction suggestions for misspelled commands

  • REPL with command completion and access to underlying shell

  • GUI (experimental feature)

Resources

Development

Preparing Environment

./setup.sh
source venv/bin/activate

Updating Dependencies

vi requirements.in
vi setup.py
pip-compile
pip-sync

Releasing

# update version:
vi docs/source/conf.py
vi setup.py
git commit -am "foobar"
git tag 1.2.3

# upload code
git push
git push --tags
python3 setup.py build sdist
twine upload dist/kickoff-1.2.3.tar.gz

# upload documentation
log into readthedocs.io and trigger a Build

Donations

It is absolutely fine if you use this software for free for commercial or non-commercial purposes. On the other hand, if you would like to repay author’s efforts you are welcome to use following button:

https://www.paypalobjects.com/en_US/PL/i/btn/btn_donateCC_LG.gif

Metadata

Release files for kickoff 0.5.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kickoff 0.5.11
File Size Uploaded Provenance Actions
kickoff-0.5.11.tar.gz 12.2 kB Without provenance Details for kickoff-0.5.11.tar.gz

Release files / kickoff-0.5.11.tar.gz

Download URL kickoff-0.5.11.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
be51dbf6d33c21b35a06fb71fc0d70c09756b710f5dc3740c4da7ebe57e227cf
BLAKE2b-256 checksum
How to use checksums
9576ad43c4b799f029d7da08ebc35fdc020bfeaa23cc7183e7fdbf390f42e0b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.43.0 CPython/3.8.2

Security for kickoff 0.5.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page