rich click
v1.8.4
Interfaces de ligne de commande richement rendues en un clic.
Documentation · Code source · Journal des modifications
rich-click est une cale autour de Click qui restitue joliment la sortie d'aide en utilisant Rich.
L'intention de rich-click est de fournir une sortie d'aide attrayante à partir de Click, formatée avec Rich, avec une personnalisation minimale requise.
import rich_click as clickrich-click )pip install rich-clickLisez la documentation pour toutes les méthodes d'installation prises en charge.
Pour utiliser rich-click dans votre code, remplacez import click par import rich_click as click dans votre CLI de clic existante :
import rich_click as click
@ click . command ()
@ click . option ( "--count" , default = 1 , help = "Number of greetings." )
@ click . option ( "--name" , prompt = "Your name" , help = "The person to greet." )
def hello ( count , name ):
"""Simple program that greets NAME for a total of COUNT times."""
for _ in range ( count ):
click . echo ( f"Hello, { name } !" )
if __name__ == '__main__' :
hello () Capture d'écran de examples/11_hello.py
Capture d'écran de examples/03_groups_sorting.py
Ceci est un aperçu rapide de la façon d’utiliser le clic enrichi . Lisez la documentation pour plus d'informations.
Il existe plusieurs façons de commencer à utiliser rich-click :
rich_click en tant que click Désactivez votre importation click normale avec rich_click , en utilisant le même espace de noms :
import rich_click as clickC'est ça! Continuez ensuite à utiliser Click comme vous le feriez normalement.
Voir
examples/01_simple.pypour un exemple.
Si vous préférez, vous pouvez plutôt utiliser RichGroup ou RichCommand avec l'argument cls dans votre utilisation des clics. Cela signifie que vous pouvez continuer à utiliser le package click non modifié en parallèle.
import click
from rich_click import RichCommand
@ click . command ( cls = RichCommand )
def main ():
"""My amazing tool does all the things."""Voir
examples/02_declarative.pypour un exemple.
rich-clickrich-click est livré avec un outil CLI qui vous permet de formater la sortie d'aide Click de n'importe quel package utilisant Click.
Pour l'utiliser, préfixez rich-click à votre commande normale. Par exemple, pour enrichir le texte d'aide Click d'un package appelé awesometool , vous pouvez exécuter :
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. Ce projet est sous licence MIT.
