click-contrib¶
As the user number of Click grows, more and more major feature requests are made. To users, it may seem reasonable to include those features with Click; however, many of them are experimental or aren’t practical to support generically. Maintainers have to choose what is reasonable to maintain in Click core.
The click-contrib GitHub organization exists as a place to collect third-party packages that extend Click’s features. It is also meant to ease the effort of searching for such extensions.
Please note that the quality and stability of those packages may be different from Click itself. While published under a common organization, they are still separate from Click and the Pallets maintainers.
Third-party projects¶
Other projects that extend Click’s features are available outside the click-contrib organization.
Some of the most popular and actively maintained are listed below:
Project |
Description |
Popularity |
Activity |
|---|---|---|---|
Use Python type hints to create CLI apps. |
|||
Format help output with Rich. |
|||
Speed up tab completion scripts and support more shells. |
|||
Cookiecutter template for creating new CLIs. |
|||
Adds option groups, constraints, command aliases, help themes, suggestions and more. |
|||
Cloup + colorful |
Interactive input libraries¶
Click reads a prompt with the built-in input() and embeds no line editor of its own. If you need fancy features like completion of arbitrary values, selection menus or fuzzy search you need to replace click.prompt() with a third-party library. The projects below are popular and actively maintained:
Project |
Description |
Popularity |
Activity |
|---|---|---|---|
Build terminal and web user interfaces with a Python API. |
|||
Build interactive command lines with completion, history and key bindings. |
Note
To make it into any of the lists above, a project:
must be actively maintained (at least one commit in the last year)
must have a reasonable number of stars (at least 20)
If you have a project that meets these criteria, please open a pull request to add it to the list.
If a project is no longer maintained or does not meet the criteria above, please open a pull request to remove it from the list.