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/
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file click-shell-2.1.tar.gz.
File metadata
- Download URL: click-shell-2.1.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce0c91faae284c41a39bec966f928791ad4a45763755445f1fe2041fd091aa37
|
|
| MD5 |
5c9efd193ee167528c63b2d0506feef8
|
|
| BLAKE2b-256 |
9e2693dd93fb1714f64376989b9e809982fd64d5f26e666b6d55458066c40b53
|
File details
Details for the file click_shell-2.1-py2.py3-none-any.whl.
File metadata
- Download URL: click_shell-2.1-py2.py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d971a2e50eb7ad387cf0ce79ba4b844e66e0580784e2efe2df58b50a2f047f0
|
|
| MD5 |
29b65ca22c98301c4e0bf62ca7066e93
|
|
| BLAKE2b-256 |
21ced81dcb726c436bf3f77d0145e03bf364c189cc95e6551e797bc0511dcea0
|
