Skip to main content

Option groups and subcommand help sections for pallets/click

Project description

Overview

Master branch Tests status Coverage Status Documentation Status (master branch)
Latest release Latest release on PyPI Supported versions Documentation Status (latest release)

Cloup (= Click + groups) contains a set of Click extensions that enable you to:

  • define option groups with a clean API;
  • define constraints, including conditional constraints, on any group of parameters (e.g. mutually_exclusive, RequireAtLeast(1) etc.);
  • (optionally) show an auto-generated description of defined constraints in the command help;
  • organize the subcommands of a MultiCommand in multiple help sections.

These features are implemented in three “mixins” following the same pattern of click-contrib extensions (cooperative multiple inheritance). For ease of use, Cloup also provides:

  • its own versions of Click commands classes, obtained by mixing Click classes with the above mentioned mixins;
  • its own versions of Click command decorators, for creating such commands.

Documentation

Read more in the documentation:

Change Log

v0.7.0 (2021-03-24)

Compatible changes and features

  • In constraint errors, the way the parameter list is formatted has changed. Instead of printing a comma-separated list of single labels:

    • each parameter is printed on a 2-space indented line and
    • both the short and long name of options are printed.

    See the relevant commit.

  • Minor improvements to code and docs.

v0.6.1 (2021-03-01)

This patch release fixes some problems in the management and releasing of the package.

  • Add a py.typed file to ship the package with type hints (PEP 561).
  • Use setuptools-scm to automatically manage the version of the package and the content of the source distribution based on the git repository:
    • the source distribution now matches the git repository, with the only exception of _version.py, which is not tracked by git; it’s generated by setuptools-scm and included in the package;
    • tox.ini and Makefile were updated to account for the fact that _version.py doesn’t exist in the repository before installing the package.
  • The new attribute cloup.__version_tuple__ stores the version as a tuple (of at least 3 elements).

v0.6.0 (2021-02-28)

Incompatible changes

  • Removed the deprecated GroupSection as previously announced. Use the new name instead: Section.
  • In Group.group() and Group.command, the argument section was moved after the cls argument so that the signatures are now fully compatible with those of the parent class (the Liskov substitution principle is now satisfied). If you (wisely) passed section and cls as keyword arguments in your code, you don’t need to change anything.

Compatible changes

  • Slightly improved return type (hint) of command decorators.
  • Minor refactoring of ConstraintMixin.
  • Improved the documentation.

v0.5.0 (2021-02-10)

Requirements

  • Drop support to Python 3.5.

Deprecated

  • GroupSection was renamed as Section.

Compatible changes and features

  • Added a subpackage for defining constraints on parameters groups (including OptionGroup’s).
  • The code for adding support to option groups was extracted to OptionGroupMixin.
  • Most of the code for adding support to subcommand sections was extracted to SectionMixin.

Project changes

  • Migrated from TravisCI to GitHub Actions.

v0.4.0 (2021-01-10)

Requirements

  • This is the last release officially supporting Python 3.5.

Compatible changes and features

  • Changed the internal (non-public) structure of the package.
  • Minor code improvements.

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.

Files for cloup, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size cloup-0.7.0-py2.py3-none-any.whl (23.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size cloup-0.7.0.tar.gz (55.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page