Metadata-Version: 2.1
Name: kickoff
Version: 0.3.3
Summary: Turns your Python script or module into an application with decent CLI.
Home-page: https://github.com/gergelyk/python-kickoff
Author: Grzegorz Krason
Author-email: grzegorz.krason@gmail.com
License: MIT
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 <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 --tags
            python3 setup.py build sdist
            twine upload dist/kickoff-1.2.3.tar.gz
        
            # upload documentation
            nothing to be done, it is automatically triggered by github
        
        
        
        
        
        
Keywords: cli,cui,argparse,optparse,docopt,click,fire,invoke,runfile
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Other Environment
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: License :: Freeware
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: iOS
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: ~=3.6
Description-Content-Type: text/x-rst
