Option groups for pallets/click
Project description
cloup
Adds option groups to pallets/click.
This package only affects how the command help is formatted, it doesn’t (and never will) allow to specify constraints on option groups. Look at click-option-group if you want that.
Free software: MIT license
Example
The following code
import click
import cloup
from cloup import option_group, option
@cloup.command('clouptest')
@click.argument('arg')
@option_group('Option group A', [
option('--a1', help='1st option of group A'),
option('--a2', help='2nd option of group A'),
option('--a3', help='3rd option of group A')],
help='This is a useful description of group A',
)
@option_group('Option group B', [
option('--b1', help='1st option of group B'),
option('--b2', help='2nd option of group B'),
option('--b3', help='3rd option of group B'),
])
@option('--opt1', help='an uncategorized option')
@option('--opt2', help='another uncategorized option')
def cli(**kwargs):
""" A CLI that does nothing. """
print(kwargs)
… will print:
Usage: clouptest [OPTIONS] [ARG] A CLI that does nothing. Option group A: This is a useful description of group A --a1 TEXT 1st option of group A --a2 TEXT 2nd option of group A --a3 TEXT 3rd option of group A Option group B: --b1 TEXT 1st option of group B --b2 TEXT 2nd option of group B --b3 TEXT 3rd option of group B Other options: --opt1 TEXT an uncategorized option --opt2 TEXT another uncategorized option --help Show this message and exit.
Credits
I started from the code written by @chrisjsewell in this comment.
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
0.1.0 (2020-02-25)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
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.1.2.tar.gz
(11.2 kB
view hashes)
Built Distribution
Close
Hashes for cloup-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ed390af49c2a2a19ada9ca654f22705ed83b25413a55656d16e26e4b4e8d903 |
|
MD5 | 4cbc6872475c96900f5e3f822f8756f3 |
|
BLAKE2b-256 | 8b2b1bf9f17c1ca8a704d98feb35c496853268139b17f227f231c6882de95d18 |