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
The documentation is available on Read The Docs.
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.
A Makefile is provided for easy interaction with the project. To see
all available options run:
make help
To run all tests in the suite run:
make tests
To locally verify documentation changes run:
make docs
After running, newly generated documentation shall be available at
./docs/_build/html/.
Free software: GNU Lesser General Public License v3