Skip to main content

An extension to click that easily turns your click app into a shell utility

Project description

Build status Documentation Status

click-shell is an extension to click that easily turns your click app into a shell utility. It is built on top of the built in python cmd module, with modifications to make it work with click.

Usage

Simply replace @click.group with @click_shell.shell on the root level command:

from click_shell import shell

# @click.group()  # no longer
@shell(prompt='my-app > ', intro='Starting my app...')
def my_app(ctx):
    pass

@my_app.command()
def the_command():
    print 'the_command is running'

...

When run, you should expect an output like so:

$ python my_app.py
Starting my app...
my-app >

Note

It should be noted that this decorator only alters functionality if no arguments are passed on the command line. If you try to run a command directly (like python my_app.py the_command in the above example), your app will function identically to how it did before.

For more advanced usage, check out our docs at http://click-shell.readthedocs.org/

Project details


Download files

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

Files for click-shell, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size click_shell-0.1-py2.py3-none-any.whl (8.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size click-shell-0.1.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

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