🌈 Extra colorization and configuration file for Click.
Project description
Click Extra
What is Click Extra?
click-extra is a collection of helpers and utilities for
Click, the Python CLI framework.
It provides boilerplate code and good defaults, as weel as some workarounds and patches that have not reached upstream yet (or are unlikely to).
Used in
- Mail Deduplicate - A CLI to deduplicate similar emails.
- Meta Package Manager - A unifying CLI for multiple package managers.
Installation
Install click-extra with pip:
$ pip install click-extra
Features
- TOML configuration file loader
- Colorization of help screens
--color/--no-coloroption flag- Colored
--versionoption - Colored
--verbosityoption and logs --time/--no-timeflag to measure duration of command execution- Platform recognition utilities (macOS, Linux and Windows)
- New conditional markers for
pytest:@skip_linux,@skip_macosand@skip_windows@unless_linux,@unless_macosand@unless_windows@destructiveand@non_destructive
Issues addressed by click-extra
Keep track of things to undo if they reach upstream.
- Add a
no-coloroption, method or parameter to disable colouring globally (#30) - Log level is leaking between invokations: hack to force-reset it (#29)
- Add missing string interpolation in error message (#24)
- Add trailing dot to help text (#18)
- Add support for option groups on
cloup.Group(#98) - Styling metavars, default values, env var, choices (#97) & Highlights options, choices and metavars (#95)
- Add loading of options from a TOML configuration file (#96)
TOML configuration file
Allows a CLI to read defaults options from a configuration file.
Here is a sample:
# My default configuration file.
[my_cli]
verbosity = "DEBUG"
manager = ["brew", "cask"]
[my_cli.search]
exact = true
Colorization of help screen
Extend Cloup's own help formatter and theme to add colorization of:
- Options
- Choices
- Metavars
Dependencies
Here is a graph of Python package dependencies:
Development
Development guidelines
are the same as
parent project mpm, from
which click-extra originated.
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 click-extra-1.2.0.tar.gz.
File metadata
- Download URL: click-extra-1.2.0.tar.gz
- Upload date:
- Size: 24.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8e1b90a584c324dbf44e57c27d904c6f57573dc031eaa45edac6dfbb3009dbd6 |
|
| MD5 | 96a900a4ce4bee7ddbdbdff735ce8754 |
|
| BLAKE2b-256 | c5d79bbe8afb8f661238bc98f2dc3257a777380782c6bc8eb9d8925392692b8a |
File details
Details for the file click_extra-1.2.0-py3-none-any.whl.
File metadata
- Download URL: click_extra-1.2.0-py3-none-any.whl
- Upload date:
- Size: 36.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 209da62ada5bd96f4ea72d6fa3b09d6e032339b43a072217af38313d41a542c5 |
|
| MD5 | 488e3f7f952b9d1d0ddc386626fcf95c |
|
| BLAKE2b-256 | 5c33d8094ec1ff312b244ed8487da253bfdcf190992f32953500455c2826eb77 |
