rich click
v1.8.4
Reichhaltig gerenderte Befehlszeilenschnittstellen per Klick.
Dokumentation · Quellcode · Änderungsprotokoll
rich-click ist eine Unterlage für Click, die die Hilfeausgabe mit Rich gut darstellt.
Der Zweck von rich-click besteht darin, attraktive Hilfeausgaben von Click bereitzustellen, die mit Rich formatiert sind und nur minimale Anpassungen erfordern.
import rich_click as clickrich-click voran)pip install rich-clickLesen Sie die Dokumentation für alle unterstützten Installationsmethoden.
Um Rich-Click in Ihrem Code zu verwenden, ersetzen Sie import click durch import rich_click as click in Ihrer vorhandenen Click-CLI:
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 () Screenshot von examples/11_hello.py
Screenshot von examples/03_groups_sorting.py
Dies ist ein kurzer Überblick über die Verwendung von Rich-Click . Weitere Informationen finden Sie in den Dokumenten.
Es gibt mehrere Möglichkeiten rich-click zu verwenden:
rich_click als click importieren Ersetzen Sie Ihren normalen click durch rich_click und verwenden Sie dabei denselben Namespace:
import rich_click as clickDas ist es! Anschließend verwenden Sie Click wie gewohnt weiter.
Ein Beispiel finden Sie
examples/01_simple.py.
Wenn Sie möchten, können Sie stattdessen RichGroup oder RichCommand mit dem cls Argument in Ihrer Klickverwendung verwenden. Das bedeutet, dass Sie das unveränderte click parallel weiter nutzen können.
import click
from rich_click import RichCommand
@ click . command ( cls = RichCommand )
def main ():
"""My amazing tool does all the things."""Ein Beispiel finden Sie
examples/02_declarative.py.
rich-click CLI-Toolrich-click wird mit einem CLI-Tool geliefert, mit dem Sie die Click-Hilfeausgabe von jedem Paket formatieren können, das Click verwendet.
Um es zu verwenden, stellen Sie rich-click Ihrem normalen Befehl voran. Um beispielsweise Richified Click-Hilfetext aus einem Paket namens awesometool zu erhalten, könnten Sie Folgendes ausführen:
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. Dieses Projekt ist unter der MIT-Lizenz lizenziert.
