🌈 Extra colorization and configuration loading for Click.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for kdeldycke from gravatar.com kdeldycke

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 or later (GPLv2+) (GPL-2.0-or-later)
  • Author: Kevin Deldycke
  • Tags ansi-colors, cli, cli-helper, click-help-color, click-log, cloup, colorization, configuration, console, ini, json, logging, multiplatform, pygments, pytest, python, python-tabulate, sphinx, terminal, toml, xml, yaml
  • Requires: Python >=3.7, <4.0
Classifiers

Project description

Click Extra

Last release Python versions Unittests status Documentation status Coverage status DOI

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:

click CLI help screen

Into this:

click-extra CLI help screen

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:

Development

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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for kdeldycke from gravatar.com kdeldycke

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 or later (GPLv2+) (GPL-2.0-or-later)
  • Author: Kevin Deldycke
  • Tags ansi-colors, cli, cli-helper, click-help-color, click-log, cloup, colorization, configuration, console, ini, json, logging, multiplatform, pygments, pytest, python, python-tabulate, sphinx, terminal, toml, xml, yaml
  • Requires: Python >=3.7, <4.0
Classifiers

Release history Release notifications | RSS feed

4.11.5

4.11.4

4.11.3

4.11.2

4.11.1

4.11.0

4.10.0

4.9.0

4.8.3

4.8.2

4.8.1

4.8.0

4.7.5

4.7.4

4.7.3

4.7.2

4.7.1

4.7.0

4.6.5

4.6.4

4.6.3

4.6.2

4.6.1

4.6.0

4.5.0

4.4.0

4.3.0

4.2.0

4.1.0

4.0.0

3.10.0

3.9.0

3.8.3

3.8.2

3.8.1

3.8.0

3.7.0

3.6.0

3.5.0

This version

3.4.1

3.4.0

3.3.4

3.3.3

3.3.1

3.3.0

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.0

3.0.1

3.0.0

2.1.3

2.1.2

2.1.1

2.1.0

2.0.2

2.0.1

2.0.0

1.9.0

1.8.0

1.7.0

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.0

1.4.1

1.4.0

1.3.0

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

click_extra-3.4.1.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

click_extra-3.4.1-py3-none-any.whl (67.1 kB view details)

Uploaded Python 3

File details

Details for the file click_extra-3.4.1.tar.gz.

File metadata

  • Download URL: click_extra-3.4.1.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.16

File hashes

Hashes for click_extra-3.4.1.tar.gz
Algorithm Hash digest
SHA256 fe79e55b9689eb09ed6890f7b3a79e44afc7749519f6faf061c75034b3a1f37a
MD5 6903e7d99d7eeeedcfc8968c94c76141
BLAKE2b-256 7e21a8bf333c9fa0438961afa529c9870591ad90ab5c419b9e792a3f741b62d7

See more details on using hashes here.

File details

Details for the file click_extra-3.4.1-py3-none-any.whl.

File metadata

  • Download URL: click_extra-3.4.1-py3-none-any.whl
  • Upload date:
  • Size: 67.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.16

File hashes

Hashes for click_extra-3.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 88262a609824081e757839fed37b27541189d3d26fca29a73328a328c7964622
MD5 873bf56e73683458984f8b131db4dfb5
BLAKE2b-256 aec9127f3e9737bf1741e9a8104d7647a5b3ff4445a6e89eaacd8f17b70c4050

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page