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 cloup
from cloup import option_group
@cloup.command('clouptest')
@option_group('Option group A', [
cloup.option('--a1', help='1st option of group A'),
cloup.option('--a2', help='2nd option of group A'),
cloup.option('--a3', help='3rd option of group A')],
help='This is a useful description of group A',
)
@option_group('Option group B', [
cloup.option('--b1', help='1st option of group B'),
cloup.option('--b2', help='end option of group B'),
cloup.option('--b3', help='3rd option of group B'),
])
@cloup.option('--opt1', help='an uncategorized option')
@cloup.option('--opt2', help='another uncategorized option')
def cli(**kwargs):
""" A CLI that does nothing. """
print(kwargs)
if __name__ == '__main__':
cli()
… will print:
Usage: clouptest [OPTIONS] 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 end 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 writte 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.
Metadata
Release files for cloup 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cloup-0.1.1.tar.gz | 10.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cloup-0.1.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 15.7 kB
Release files / cloup-0.1.1.tar.gz
| Download URL | cloup-0.1.1.tar.gz |
|---|---|
| Size | 10.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a2a7818dbf06b6f0e8875ba5947ebfe37383aaa893e907afa819ff3fb0d96da4
|
|
BLAKE2b-256 checksum How to use checksums |
5d85f5db6dbe745e4196c13b65bd791ba75cfdc35c6b388e5f557d30f36441ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0
|
Release files / cloup-0.1.1-py2.py3-none-any.whl
| Download URL | cloup-0.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
27bd7c1e46f440bdedd763700cae6ae96f54b834f022ca0422ef0bf90020f029
|
|
BLAKE2b-256 checksum How to use checksums |
4595fdc8f2a4a1ab271d4383364cbae030865c5f506902c8db72862e22623304
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0
|