click_default_group
Project Links
Meta
Author: Heungsub Lee
Requires Python: >=2.7
Classifiers
Development Status
- 5 - Production/Stable
Intended Audience
- Developers
License
- Public Domain
Programming Language
- Python
- Python :: 2
- Python :: 2.7
- Python :: 3
- Python :: 3.5
- Python :: 3.6
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: Implementation :: CPython
- Python :: Implementation :: PyPy
Click Default Group
DefaultGroup
is a sub class of click.Group
. But it invokes a default
subcommand instead of showing a help message when a subcommand is not passed.
Usage
Define a default subcommand by default=NAME
:
import click
from click_default_group import DefaultGroup
@click.group(cls=DefaultGroup, default='foo', default_if_no_args=True)
def cli():
pass
@cli.command()
def foo():
click.echo('foo')
@cli.command()
def bar():
click.echo('bar')
Then you can invoke that without explicit subcommand name:
$ cli.py --help
Usage: cli.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Command:
foo*
bar
$ cli.py
foo
$ cli.py foo
foo
$ cli.py bar
bar
Compatibility
click-default-group
is compatible with these Click versions:
- Click-7.0
- Click-6.x
- Click-5.1
- Click-5.0
- Click-4.1
- Click-4.0
See the latest build status at Travis CI.
Licensing
Written by Heungsub Lee, and distributed under the BSD 3-Clause license.
Aug 04, 2023
1.2.4
Aug 04, 2023
1.2.3
Sep 05, 2019
1.2.2
Jun 14, 2019
1.2.1
May 30, 2016
1.2
Dec 01, 2015
1.1
Nov 30, 2015
1.0