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.3.tar.gz (18.9 kB view details)

Uploaded Source

File details

Details for the file precept-0.6.3.tar.gz.

File metadata

  • Download URL: precept-0.6.3.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.7.4

File hashes

Hashes for precept-0.6.3.tar.gz
Algorithm Hash digest
SHA256 4e320ba4f1bb5866cb0844c8d94f783f9d1f40c49143fdd6d0eabfb03fb6c430
MD5 723fc80f5f1e1bdc46b504ebd43c2487
BLAKE2b-256 224363c4cddc874e37404f4fce37824775e36a0c29a8af9cc19d60525fa98def

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page