awesome-python icon indicating copy to clipboard operation
awesome-python copied to clipboard

Add click-extra.

Open kdeldycke opened this issue 2 years ago • 0 comments

What is this Python project?

click-extra is 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).

What's the difference between this Python project and similar ones?

This project adds the following features on top of click:

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

--

Anyone who agrees with this pull request could submit an Approve review to it.

kdeldycke avatar Nov 28 '22 08:11 kdeldycke