semvec/pypi-packages huggingface dataset:
kickoff 0.5.11
Turns your Python script or module into an application with decent CLI.
License: MIT
Requires Python: ~=3.6
Keywords: cli,cui,argparse,optparse,docopt,click,fire,invoke,runfile

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 <http://www.pyinvoke.org>`__, `fire <https://github.com/google/python-fire>`__, `runfile <https://code.activestate.com/pypm/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 <https://click.palletsprojects.com/>`__ 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
========= 	

* `Source Code <https://github.com/gergelyk/python-kickoff>`__
* `Package <https://pypi.org/project/kickoff/>`__
* `Documentation <https://python-kickoff.readthedocs.io/en/latest/>`__


Development
===========

Preparing Environment
^^^^^^^^^^^^^^^^^^^^^

.. code:: python

    ./setup.sh
    source venv/bin/activate

Updating Dependencies
^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

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

Releasing
^^^^^^^^^

.. code:: bash

    # 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:

.. image:: https://www.paypalobjects.com/en_US/PL/i/btn/btn_donateCC_LG.gif
   :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D9KUJD9LTKJY8&source=url