rich click

Interfaces de línea de comando ricamente renderizadas al hacer clic.

---

Documentación · Código fuente · Registro de cambios

---

rich-click es una corrección alrededor de Click que genera una buena salida de ayuda usando Rich.

• Click es un "paquete de Python para crear hermosas interfaces de línea de comandos" .
• Rich es una "biblioteca de Python para texto enriquecido y formato atractivo en la terminal" .

La intención del rich-click es proporcionar una salida de ayuda atractiva desde Click, formateada con Rich, con una personalización mínima requerida.

Características

• ? Formato enriquecido de línea de comandos de ayuda al hacer clic y mensajes de error
• ? Misma API que Click: el uso es simplemente import rich_click as click
• ? Bonitos estilos por defecto
• Herramienta CLI para ejecutar en las herramientas de otras personas (anteponga el comando con rich-click )
• ? Exportar texto de ayuda como HTML o SVG
• ? Agrupe comandos y opciones en paneles con nombre
• Mensajes de error bien formateados
• ? Ofrezca fácilmente un orden de clasificación personalizado para opciones y comandos
• ? Es posible una amplia personalización del estilo y el comportamiento.

Instalación

pip install rich-click

Lea los documentos para conocer todos los métodos de instalación admitidos.

Ejemplos

Ejemplo sencillo

Para usar el clic enriquecido en su código, reemplace import click con el clic import rich_click as click en su CLI de clic existente:

 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 ()

Captura de pantalla de examples/11_hello.py

Ejemplo más complejo

Captura de pantalla de examples/03_groups_sorting.py

Uso

Esta es una descripción general rápida de cómo utilizar el clic enriquecido . Lea los documentos para obtener más información.

Hay un par de formas de empezar a utilizar rich-click :

Importar rich_click como click

Cambie su importación click normal con rich_click , usando el mismo espacio de nombres:

 import rich_click as click

¡Eso es todo! Luego continúe usando Click como lo haría normalmente.

Consulte examples/01_simple.py para ver un ejemplo.

Declarativo

Si lo prefiere, puede utilizar RichGroup o RichCommand con el argumento cls en su uso de clics. Esto significa que puede seguir utilizando el paquete click sin modificar en paralelo.

 import click
from rich_click import RichCommand

@ click . command ( cls = RichCommand )
def main ():
    """My amazing tool does all the things."""

Consulte examples/02_declarative.py para ver un ejemplo.

herramienta CLI rich-click

rich-click viene con una herramienta CLI que le permite formatear la salida de ayuda de Click desde cualquier paquete que use Click.

Para usarlo, anteponga rich-click a su comando normal. Por ejemplo, para enriquecer el texto de ayuda de Click de un paquete llamado awesometool , puedes ejecutar:

$ rich-click awesometool --help

Usage: awesometool [OPTIONS]
..more richified output below.. 

Licencia

Este proyecto está bajo la licencia MIT.