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 testcommand():
print('testcommand is running')
# more commands
if __name__ == '__main__':
my_app()
When run, you should expect an output like so:
$ python my_app.py
Starting my app...
my-app > testcommand
testcommand is running
my-app >
For more advanced usage, check out our docs at https://click-shell.readthedocs.io/
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-2.0.tar.gz
(6.8 kB
view hashes)
Built Distribution
Close
Hashes for click_shell-2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30c503efeb246c911efa708eb1d957559d7beb3aaa980e0e9525ce70ceb3f14f |
|
MD5 | aa88f14646674420f0dc4d51404fe1da |
|
BLAKE2b-256 | 98eb7e09db5154c52905a61b36518a7013dfba0450116aa75cef80bfc7af36a8 |