click-extra 1.1.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

• Meta Package Manager - A unifying CLI for multiple package managers.
• Mail Deduplicate - A CLI to deduplicate similar emails.

Installation

Install click-extra with pip:

$ pip install click-extra

Features

• TOML 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
• New conditional markers for pytest:
  • @skip_linux, @skip_macos and @skip_windows
  • @unless_linux, @unless_macos and @unless_windows
  • @destructive and @non_destructive

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

This has been discussed upstream at:

• https://github.com/janluke/cloup/issues/97
• https://github.com/click-contrib/click-help-colors/issues/17
• https://github.com/janluke/cloup/issues/95

Dependencies

Here is a graph of Python package dependencies:

Development

Development guidelines are the same as parent project mpm, from which click-extra originated.