"Command Line Interface"
Project description
Craft CLI
A Command Line Client builder that follows the Canonical's Guidelines for a Command Line Interface.
The library provides two main functionalities:
-
a framework to define and execute application commands, which involves argument parsing and the provision of help texts
-
infrastructure to handle the terminal and present all the outputs for the different application needs
Documentation
The documentation is available on Read The Docs.
Setting up the environment
Install at system level:
sudo snap install pyright
Create a virtual environment, activate it, and install developer dependencies:
python3 -m venv env
source env/bin/activate
pip install .[dev]
That's all.
Contributing
A Makefile is provided for easy interaction with the project. To see
all available options run:
make help
Running tests
To run all tests in the suite run:
make tests
Verifying documentation changes
To locally verify documentation changes run:
make docs
After running, newly generated documentation shall be available at
./docs/_build/html/.
License
Free software: GNU Lesser General Public License v3
Release history Release notifications | RSS feed
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
File details
Details for the file craft-cli-1.0.0.tar.gz.
File metadata
- Download URL: craft-cli-1.0.0.tar.gz
- Upload date:
- Size: 27.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 61e9476f0410fc7002b82610b2dc53631a84c0f46e57d4bd1382245c983799ce |
|
| MD5 | 18149388289f8acbcccd089770dc5373 |
|
| BLAKE2b-256 | 472ccfc2b4c6536cc8c8672f932b8c902ea231bfbae758c1b2c63b142ce4c9cd |
File details
Details for the file craft_cli-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: craft_cli-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 29.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b3623f4058434023a8e15b0dbc0fa7f177f71ab778f158e0bf44308f1c339d44 |
|
| MD5 | a8ab01c6f03b64637982a21e622579c6 |
|
| BLAKE2b-256 | 877b86c7d97de6d1b8a9dfa6ac81054979b946e4a481a3a0ce0970304fd67ca0 |
