click-extra 2.1.1

🌈 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 you some boilerplate code. It also comes with some workarounds and patches that have not reached upstream yet (or are unlikely to).

Simple click example	Same with click-extra
from click import command, echo, option @command() @option("--count", default=1, help="Number of greetings.") @option("--name", prompt="Your name", help="The person to greet.") def hello(count, name): """Simple program that greets NAME for a total of COUNT times.""" for _ in range(count): echo(f"Hello, {name}!") if __name__ == "__main__": hello()	from click_extra import command, echo, option @command() @option("--count", default=1, help="Number of greetings.") @option("--name", prompt="Your name", help="The person to greet.") def hello(count, name): """Simple program that greets NAME for a total of COUNT times.""" for _ in range(count): echo(f"Hello, {name}!") if __name__ == "__main__": hello()

This example demonstrate the all-in-one package with its default options. You are still free to pick-up some of these options one-by-one, as documented below.

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, sets, …)
  • XML
• Download configuration from remote URLs
• Optional strict validation of configuration
• Automatic search of configuration file from default user folder
• Respect of CLI > Configuration > Environment > Defaults precedence
• 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
• Fixes 20+ 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:

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

Development

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