precept

CircleCI Documentation Status Coverage Status PyPI version LICENSE Downloads

Async application framework.

Install

Install with pip: $ pip install precept

Usage

Basic:

from precept import Precept, Command, Argument

class MyCli(Precept):
    """
    The name of the application will be the spinal-case version of
    the name of the class.

    Class docstring is added as cli description.
    """
    @Command(Argument('argument', type=str))
    async def my_command(self, argument):
        print(argument)

def cli():
    MyCli().start()

if __name__ == '__main__':
   cli()

For local testing:

  • Set entry_points.console_script to my-cli = my_package.my_cli:cli in setup.py

  • Install locally: $ pip install -e .

  • Then call: $ my-cli my-command hello -> print hello

**Full documentation**