rich click
v1.8.4
Interfaces de linha de comando ricamente renderizadas com um clique.
Documentação · Código fonte · Changelog
rich-click é uma correção em torno do Click que renderiza muito bem a saída de ajuda usando Rich.
A intenção do rich-click é fornecer uma saída de ajuda atraente do Click, formatada com Rich, com o mínimo de personalização necessária.
import rich_click as clickrich-click )pip install rich-clickLeia a documentação para todos os métodos de instalação suportados.
Para usar rich-click em seu código, substitua import click por import rich_click as click em sua CLI de clique 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 tela de examples/11_hello.py
Captura de tela de examples/03_groups_sorting.py
Esta é uma rápida visão geral de como usar o rich-click . Leia a documentação para obter mais informações.
Existem algumas maneiras de começar a usar rich-click :
rich_click como click Troque sua importação click normal por rich_click , usando o mesmo namespace:
import rich_click as clickÉ isso! Em seguida, continue a usar o Click como faria normalmente.
Veja
examples/01_simple.pypara ver um exemplo.
Se preferir, você pode usar RichGroup ou RichCommand com o argumento cls no uso do clique. Isso significa que você pode continuar a usar o pacote click não modificado em paralelo.
import click
from rich_click import RichCommand
@ click . command ( cls = RichCommand )
def main ():
"""My amazing tool does all the things."""Veja
examples/02_declarative.pypara ver um exemplo.
rich-clickrich-click vem com uma ferramenta CLI que permite formatar a saída de ajuda do Click de qualquer pacote que use Click.
Para usar, prefixe rich-click ao seu comando normal. Por exemplo, para obter o texto de ajuda do Click enriquecido de um pacote chamado awesometool , você pode executar:
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. Este projeto está licenciado sob a licença do MIT.
