click-extra 1.3.0

🌈 Extra colorization and configuration file for Click.

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 and YAML configuration file loader
• Colorization of help screens
• --color/--no-color option flag
• Colored --version option
• Colored --verbosity option and logs
• --time/--no-time flag to measure duration of command execution
• Platform recognition utilities (macOS, Linux and Windows)
• New conditional markers for pytest:
  • @skip_linux, @skip_macos and @skip_windows
  • @unless_linux, @unless_macos and @unless_windows
  • @destructive and @non_destructive

Issues addressed by click-extra

Keep track of things to undo if they reach upstream.

click:

• testing.CliRunner.invoke cannot pass color for Context instantiation (#2110)

click-log:

• Add a no-color option, 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)

click-help-color:

• Highlighting of options, choices and metavars (#17)

cli-helper:

• Replace local tabulate formats with those available upstream (#79)

cloup:

• 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)

python-tabulate:

• Add new {rounded,simple,double}_(grid,outline} formats (#151)

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.