From 822d4fd0bcfcd0ab22c9eec550ee2dae2a3d260c Mon Sep 17 00:00:00 2001 From: Kevin Deldycke Date: Sat, 7 Dec 2024 11:01:00 +0400 Subject: [PATCH] Add links to third-party projects --- docs/contrib.rst | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/contrib.rst b/docs/contrib.rst index 287862ce0..628edd7c7 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -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 `_ 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 `_ 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 `_ 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 `_ 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 `_ 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/