Overview

Cloup — originally from “Click + option groups” — enriches Click with several features that make it more expressive and configurable:

option groups
constraints, like mutually_exclusive, that can be applied to any group of parameters, even conditionally
subcommand aliases
subcommands sections, i.e. the possibility to organize the subcommands of a Group in multiple help sections
a themeable HelpFormatter that:
- has more parameters for adjusting widths and spacing, which can be provided at the context and command level
- use a different layout when the terminal width is below a certain threshold in order to improve readability.

Moreover, Cloup improves on IDE support providing decorators with detailed type hints and adding the static methods Context.settings() and HelpFormatter.settings() for creating dictionaries of settings.

Cloup is extensively tested and documented. Tests are run against multiple versions of Python (>=3.6) and Click (>=7.2).

A simple example

from cloup import (
    HelpFormatter, HelpTheme, Style,
    command, option, option_group
)
from cloup.constraints import RequireAtLeast, mutually_exclusive

# Check the docs for all available arguments of HelpFormatter and HelpTheme.
formatter_settings = HelpFormatter.settings(
    theme=HelpTheme(
        invoked_command=Style(fg='bright_yellow'),
        heading=Style(fg='bright_white', bold=True),
        constraint=Style(fg='magenta'),
        col1=Style(fg='bright_yellow'),
    )
)

# In a multi-command app, you can pass formatter_settings as part
# of your context_settings so that they are propagated to subcommands.
@command(formatter_settings=formatter_settings)
@option_group(
    "Cool options",
    option('--foo', help='This text should describe the option --foo.'),
    option('--bar', help='This text should describe the option --bar.'),
    constraint=mutually_exclusive,
)
@option_group(
    "Other cool options",
    "This is the optional description of this option group.",
    option('--pippo', help='This text should describe the option --pippo.'),
    option('--pluto', help='This text should describe the option --pluto.'),
    constraint=RequireAtLeast(1),
)
def cmd(**kwargs):
    """This is the command description."""
    pass

if __name__ == '__main__':
    cmd(prog_name='invoked-command')

If you don’t provide --pippo or --pluto:

Usage: invoked-command [OPTIONS]
Try 'invoked-command --help' for help.

Error: at least 1 of the following parameters must be set:
  --pippo
  --pluto

Supporting the project

Designing, testing and documenting a library takes a lot of time. The most concrete way to show your appreciation and to support future development is by donating. Any amount is appreciated.

Apart from that, you can help the project by starring it on GitHub, reporting issues, proposing improvements and contributing with your code!

Metadata

Release files for cloup 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cloup 0.10.0
File	Size	Uploaded
cloup-0.10.0.tar.gz	219.1 kB	Jul 13, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for cloup 0.10.0
File	Interpreter	ABI	Platform	Reset
cloup-0.10.0-py2.py3-none-any.whl 50.4 kB Jul 13, 2021	Python 3, Python 2	none	any	Details

Total release size: 269.5 kB

Release files / cloup-0.10.0.tar.gz

Download URL	cloup-0.10.0.tar.gz
Size	219.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`7b382527433e1a8665fe2edc00bd49bcb62e12bb3321a76eb4e792edcaadfdd3`
BLAKE2b-256 checksum How to use checksums	`7a76221ebc7e5d9d4ae9b7a4f41969409748a830c7deb60d4459ec59a60c2bc8`
Upload date	Jul 13, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6`

Release files / cloup-0.10.0-py2.py3-none-any.whl

Download URL	cloup-0.10.0-py2.py3-none-any.whl
Size	50.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`a0c4928d64d2f4aec6f3b7d14c18e33e0750b594f5c7aa35597c79bbdade2717`
BLAKE2b-256 checksum How to use checksums	`4f75599fd70b354fde914519a9ea1010edc32893a62e73bbfb415475bade4e76`
Upload date	Jul 13, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6`