Welcome to Python CLI Configuration Framework documentation!¶
cliconf¶
Overview¶
Framework that lets you write CLIs with Typer that can also be configured via py-app-conf
Getting Started¶
Install cliconf:
pip install cliconf
A simple example:
import cliconf
# Do something with cliconf
Development Status¶
This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.
Developing¶
First ensure that you have pipx installed, if not, install it with pip install pipx.
Then clone the repo and run npm install and pipenv sync. Run pipenv shell
to use the virtual environment. Make your changes and then run nox to run formatting,
linting, and tests.
Develop documentation by running nox -s docs to start up a dev server.
To run tests only, run nox -s test. You can pass additional arguments to pytest
by adding them after --, e.g. nox -s test -- -k test_something.
Links¶
See the documentation here.
For more information on getting started, take a look at the tutorial and examples.
Tutorial and Examples¶
API Documentation¶
- cliconf
- cliconf package
- Submodules
- cliconf.arg_store module
- cliconf.command module
- cliconf.command_name module
- cliconf.configure module
- cliconf.dynamic_config module
- cliconf.dynamic_config_name module
- cliconf.ext_inspect module
- cliconf.ext_pyappconf module
- cliconf.ext_typer module
- cliconf.logger module
- cliconf.main module
- cliconf.options module
- cliconf.py_api module
- cliconf.settings module
- cliconf.testing module
- cliconf package