Skip to content

Commit

Permalink
Add links to third-party projects
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeldycke committed Dec 7, 2024
1 parent 8e7bed0 commit 822d4fd
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,41 @@ Please note that the quality and stability of those packages may be different
than 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 of the
click-contrib_ organization.

Some of the most popular and actively maintained are listed below:

========================================================== =========================================================================================== ================================================================================================= ======================================================================================================
Project Description Popularity Activity
========================================================== =========================================================================================== ================================================================================================= ======================================================================================================
`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
:alt: GitHub stars :alt: Last commit
`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
:alt: GitHub stars :alt: Last commit
`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
:alt: GitHub stars :alt: Last commit
`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
:alt: GitHub stars :alt: Last commit
`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
:alt: GitHub stars :alt: Last commit
========================================================== =========================================================================================== ================================================================================================= ======================================================================================================

.. note::

To make it into the list 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.

.. _click-contrib: https://github.com/click-contrib/

0 comments on commit 822d4fd

Please sign in to comment.