Skip to content

Commit 822d4fd

Browse files
committed
Add links to third-party projects
1 parent 8e7bed0 commit 822d4fd

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/contrib.rst

+37
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,41 @@ Please note that the quality and stability of those packages may be different
1818
than Click itself. While published under a common organization, they are still
1919
separate from Click and the Pallets maintainers.
2020

21+
22+
Third-party projects
23+
--------------------
24+
25+
Other projects that extend Click's features are available outside of the
26+
click-contrib_ organization.
27+
28+
Some of the most popular and actively maintained are listed below:
29+
30+
========================================================== =========================================================================================== ================================================================================================= ======================================================================================================
31+
Project Description Popularity Activity
32+
========================================================== =========================================================================================== ================================================================================================= ======================================================================================================
33+
`Typer <https://github.com/fastapi/typer>`_ Use Python type hints to create CLI apps. .. image:: https://img.shields.io/github/stars/fastapi/typer?label=%20&style=flat-square .. image:: https://img.shields.io/github/last-commit/fastapi/typer?label=%20&style=flat-square
34+
:alt: GitHub stars :alt: Last commit
35+
`rich-click <https://github.com/ewels/rich-click>`_ Format help outputwith Rich. .. image:: https://img.shields.io/github/stars/ewels/rich-click?label=%20&style=flat-square .. image:: https://img.shields.io/github/last-commit/ewels/rich-click?label=%20&style=flat-square
36+
:alt: GitHub stars :alt: Last commit
37+
`click-app <https://github.com/simonw/click-app>`_ Cookiecutter template for creating new CLIs. .. image:: https://img.shields.io/github/stars/simonw/click-app?label=%20&style=flat-square .. image:: https://img.shields.io/github/last-commit/simonw/click-app?label=%20&style=flat-square
38+
:alt: GitHub stars :alt: Last commit
39+
`Cloup <https://github.com/janluke/cloup>`_ Adds option groups, constraints, command aliases, help themes, suggestions and more. .. image:: https://img.shields.io/github/stars/janluke/cloup?label=%20&style=flat-square .. image:: https://img.shields.io/github/last-commit/janluke/cloup?label=%20&style=flat-square
40+
:alt: GitHub stars :alt: Last commit
41+
`Click Extra <https://github.com/kdeldycke/click-extra>`_ Cloup + colorful ``--help``, ``--config``, ``--show-params``, ``--verbosity`` options, etc. .. image:: https://img.shields.io/github/stars/kdeldycke/click-extra?label=%20&style=flat-square .. image:: https://img.shields.io/github/last-commit/kdeldycke/click-extra?label=%20&style=flat-square
42+
:alt: GitHub stars :alt: Last commit
43+
========================================================== =========================================================================================== ================================================================================================= ======================================================================================================
44+
45+
.. note::
46+
47+
To make it into the list above, a project:
48+
49+
- must be actively maintained (at least one commit in the last year)
50+
- must have a reasonable number of stars (at least 20)
51+
52+
If you have a project that meets these criteria, please open a pull request
53+
to add it to the list.
54+
55+
If a project is no longer maintained or does not meet the criteria above,
56+
please open a pull request to remove it from the list.
57+
2158
.. _click-contrib: https://github.com/click-contrib/

0 commit comments

Comments
 (0)