An extension to click that easily turns your click app into a shell utility
Project description
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.
Features
Adds a “shell” mode with command completion to any click app
Just a one line change for most click apps
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():
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 >
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.
Source Distribution
click-shell-1.0.tar.gz
(7.2 kB
view hashes)
Built Distribution
Close
Hashes for click_shell-1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cbb8b0ef68453e460865fc8c27aee30cd75a3c4f11fc77935e43ba33072139e |
|
MD5 | a35a123332ad855cf2059eecfd37fcc2 |
|
BLAKE2b-256 | 7ed8199a80954f8a60282b8918d3e632c1810987c8afd74790c1d7141015cedf |