Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/click-contrib/click-option-group
Option groups missing in Click
https://github.com/click-contrib/click-option-group
cli click click-contrib python python-cli python-click
Last synced: about 2 months ago
JSON representation
Option groups missing in Click
- Host: GitHub
- URL: https://github.com/click-contrib/click-option-group
- Owner: click-contrib
- License: bsd-3-clause
- Created: 2019-11-29T21:29:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T20:56:59.000Z (about 2 months ago)
- Last Synced: 2024-07-30T02:54:07.939Z (about 2 months ago)
- Topics: cli, click, click-contrib, python, python-cli, python-click
- Language: Python
- Homepage: https://click-option-group.readthedocs.io
- Size: 124 KB
- Stars: 104
- Watchers: 6
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# click-option-group
[](https://pypi.python.org/pypi/click-option-group)
[](https://travis-ci.org/click-contrib/click-option-group)
[](https://coveralls.io/github/click-contrib/click-option-group?branch=master)
[](https://opensource.org/licenses/BSD-3-Clause)
**click-option-group** is a Click-extension package that adds option groups
missing in [Click](https://github.com/pallets/click/).
## Aim and Motivation
Click is a package for creating powerful and beautiful command line interfaces (CLI) in Python,
but it has no the functionality for creating option groups.
Option groups are convenient mechanism for logical structuring CLI, also it allows you to set
the specific behavior and set the relationship among grouped options (mutually exclusive options for example).
Moreover, [argparse](https://docs.python.org/3/library/argparse.html) stdlib package contains this
functionality out of the box.
At the same time, many Click users need this functionality.
You can read interesting discussions about it in the following issues:
* [issue 257](https://github.com/pallets/click/issues/257)
* [issue 373](https://github.com/pallets/click/issues/373)
* [issue 509](https://github.com/pallets/click/issues/509)
* [issue 1137](https://github.com/pallets/click/issues/1137)
The aim of this package is to provide group options with extensible functionality
using canonical and clean API (Click-like API as far as possible).
## Quickstart
### Installing
Install and update using pip:
```bash
pip install -U click-option-group
```
### A Simple Example
Here is a simple example how to use option groups in your Click-based CLI.
Just use `optgroup` for declaring option groups by decorating
your command function in Click-like API style.
```python
# app.py
import click
from click_option_group import optgroup, RequiredMutuallyExclusiveOptionGroup
@click.command()
@optgroup.group('Server configuration',
help='The configuration of some server connection')
@optgroup.option('-h', '--host', default='localhost', help='Server host name')
@optgroup.option('-p', '--port', type=int, default=8888, help='Server port')
@optgroup.option('-n', '--attempts', type=int, default=3, help='The number of connection attempts')
@optgroup.option('-t', '--timeout', type=int, default=30, help='The server response timeout')
@optgroup.group('Input data sources', cls=RequiredMutuallyExclusiveOptionGroup,
help='The sources of the input data')
@optgroup.option('--tsv-file', type=click.File(), help='CSV/TSV input data file')
@optgroup.option('--json-file', type=click.File(), help='JSON input data file')
@click.option('--debug/--no-debug', default=False, help='Debug flag')
def cli(**params):
print(params)
if __name__ == '__main__':
cli()
```
```bash
$ python app.py --help
Usage: app.py [OPTIONS]
Options:
Server configuration: The configuration of some server connection
-h, --host TEXT Server host name
-p, --port INTEGER Server port
-n, --attempts INTEGER The number of connection attempts
-t, --timeout INTEGER The server response timeout
Input data sources: [mutually_exclusive, required]
The sources of the input data
--tsv-file FILENAME CSV/TSV input data file
--json-file FILENAME JSON input data file
--debug / --no-debug Debug flag
--help Show this message and exit.
```
## Documentation
https://click-option-group.readthedocs.io