Skip to main content

Option groups and subcommand help sections for pallets/click

Project description

Cloup

Master branch

Travis-CI Build Status Coverage Status Documentation Status (master branch)

Package

Latest release on PyPI Supported versions Documentation Status (latest release)

Cloup (= Click + groups) adds to Click the following features:

  • option groups for Command;

  • the possibility to organize the subcommands of a Group in multiple help sections.

Cloup implements these features by providing subclasses of Command and Group, and by defining a new decorator @option_group(name, *options, ...) decorator.

Currently, cloup only affects how the command help is formatted, it doesn’t allow to specify constraints on option groups. Group constraints are coming though.

Documentation

Read more at https://cloup.readthedocs.io/.

Change Log

v0.4.0 (2020-01-10)

This is the last release officially supporting Python 3.5.

Package-wise:

  • changed the internal (non-public) structure of the package

  • no new features or public API changes

  • minor code improvements and fixes.

Repository-wise:

  • new documentation (hosted by ReadTheDocs)

  • tox, TravisCI, Makefile completely rewritten.

v0.3.0 (2020-03-26)

Backward incompatible API changes

  • option_groups decorator now takes options as positional arguments *options;

  • Group.section decorator now takes sections as positional arguments *sections;

  • align_sections_help was renamed to align_sections;

  • GroupSection.__init__() sorted_ argument was renamed to sorted.

Other changes

  • Additional signature for option_group: you can pass the help argument as 2nd positional argument.

  • Aligned option groups (option align_option_groups with default True).

  • More refactoring and testing.

v0.2.0 (2020-03-11)

  • [Feature] Add possibility of organizing subcommands of a cloup.Group in multiple help sections.

  • Various code improvements.

  • Backward incompatible change:
    • rename CloupCommand and CloupGroup resp. to just Command and Group.

v0.1.0 (2020-02-25)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

cloup-0.4.2.tar.gz (31.4 kB view hashes)

Uploaded Source

Built Distribution

cloup-0.4.2-py2.py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 2 Python 3

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