click-extra 3.5.0

🌈 Extra colorization and configuration loading for Click.

What is Click Extra?

A collection of helpers and utilities for Click, the Python CLI framework.

It is a drop-in replacement with good defaults that saves lots of boilerplate code and frustration. It also comes with workarounds and patches that have not reached upstream yet (or are unlikely to).

Example

It can transform this vanilla click CLI:

Into this:

To undestrand how we ended up with the result above, go read the tutorial.

Features

• Configuration file loader for:
  • TOML
  • YAML
  • JSON, with inline and block comments (Python-style # and Javascript-style //)
  • INI, with extended interpolation, multi-level sections and non-native types (list, set, …)
  • XML
• Download configuration from remote URLs
• Optional strict validation of configuration
• Search of configuration file from default user folder and glob patterns
• Respect of CLI > Configuration > Environment > Defaults precedence
• --show-params option to debug parameters defaults, values, environment variables and provenance
• Colorization of help screens
• -h/--help option names (see rant on other inconsistencies)
• --color/--no-color option flag
• Recognize the NO_COLOR environment variable convention from no-color.org
• 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
• .. click:example:: and .. click:run:: Sphinx extensions to document CLI source code and their execution
• ANSI-capable Pygments lexers for shell session and console output
• Pygments styles and filters for ANSI rendering
• Fixes 30+ bugs from other Click-related projects
• Rely on cloup to add:
  • option groups
  • constraints
  • subcommands sections
  • aliases
  • command suggestion (Did you mean <subcommand>?)

Used in

Check these projects to get real-life examples of click-extra usage:

• Meta Package Manager - A unifying CLI for multiple package managers.
• Mail Deduplicate - A CLI to deduplicate similar emails.
• fireproxng - A rewrite of the fireprox tool.
• badger-proxy - An mDNS-based reverse proxy for naming services on a local network.
• Molecular Dynamics Trajectory Analysis

Development

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