consolekit

Additional utilities for click.

Attention

consolekit disables Python’s readline history to prevent unrelated histories appearing for prompts. If the original behaviour is desired run:

import readline
readline.set_history_length(-1)
readline.set_auto_history(True)

Functions:

click_command([name, cls])	Shortcut to click.command(), with the -h/--help option enabled and a max width of 120.
click_group([name, cls])	Shortcut to click.group(), with the -h/--help option enabled and a max width of 120.
option(*param_decls, **attrs)	Shortcut to click.option(), but using consolekit.input.confirm() when prompting for a boolean flag.

click_command(name=None, cls=None, **attrs)

Shortcut to click.command(), with the -h/--help option enabled and a max width of 120.

Parameters

• name (Optional[str]) – Default None.

• cls (Type[Command]) – Default None.

• **attrs (Any) – Additional keyword arguments passed to the Command.

Return type

Callable[[Callable], Command]

click_group(name=None, cls=None, **attrs)

Shortcut to click.group(), with the -h/--help option enabled and a max width of 120.

Parameters

• name (Optional[str]) – Default None.

• cls (Type[Group]) – Default None.

• **attrs (Any) – Additional keyword arguments passed to the Group.

Return type

Callable[[Callable], ~_G]

option(*param_decls, **attrs)

Shortcut to click.option(), but using consolekit.input.confirm() when prompting for a boolean flag.

Parameters

• *param_decls (str)

• **attrs (Any) – Additional keyword arguments passed to click.command().

Return type

Callable[[~_C], ~_C]