Skip to main content

Turns your Python script or module into an application with decent CLI.

Project description

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)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kickoff, version 0.5.11
Filename, size File type Python version Upload date Hashes
Filename, size kickoff-0.5.11.tar.gz (12.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page