Skip to main content

Async cli application builder.

Project description

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

Project details


Download files

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

Source Distribution

precept-0.6.7.tar.gz (20.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page