cloup
Extends pallets/click in order to add support to option groups in the command help.
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<https://github.com/click-contrib/click-option-group>, if you want that.
Free software: MIT license
Example
The following code:
import cloup
from cloup import option_group
@cloup.command()
@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: example.py [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 of the @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.
1 maintainer
Metadata
1 maintainer
Release files for cloup 0.1.0
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.0.tar.gz | 10.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cloup-0.1.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 15.0 kB
Release files / cloup-0.1.0.tar.gz
| Download URL | cloup-0.1.0.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
49738816a8fb2045586dfd353d1dccf716c7b716a1409cefd46c44506bb0d061
|
|
BLAKE2b-256 checksum How to use checksums |
701e1c9c6569619fc71130a8a7ed28c30c5e38ef92ff572435b578dabf57ea2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4
|
Release files / cloup-0.1.0-py2.py3-none-any.whl
| Download URL | cloup-0.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 4.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
99abc2e6ac9c086220834e90712226053193602579843f77f5f4b73ac977c7b6
|
|
BLAKE2b-256 checksum How to use checksums |
ecbebd00f0660559072b27661f08d2c91ff8bc475783d8309d260e9ceff1ed25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.4
|
