rich click
v1.8.4
クリックで豊富にレンダリングされたコマンド ライン インターフェイス。
ドキュメント · ソースコード · 変更履歴
rich-click は、 Rich を使用してヘルプ出力を適切にレンダリングする Click 周りのシムです。
rich-clickの目的は、必要最小限のカスタマイズで、リッチでフォーマットされた魅力的なヘルプ出力を Click から提供することです。
import rich_click as clickだけですrich-clickを付けます)pip install rich-clickサポートされているすべてのインストール方法についてはドキュメントをお読みください。
コードでリッチクリックを使用するには、既存のクリック CLI でimport clickをimport rich_click as clickに置き換えます。
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 () examples/11_hello.pyからのスクリーンショット
examples/03_groups_sorting.pyからのスクリーンショット
これは、リッチクリックの使用方法の簡単な概要です。詳細については、ドキュメントを参照してください。
rich-click使用を開始するには、いくつかの方法があります。
rich_click clickとしてインポートする同じ名前空間を使用して、通常のclickインポートをrich_clickに切り替えます。
import rich_click as clickそれでおしまい！その後、通常どおり [クリック] を使用し続けます。
例については、
examples/01_simple.py参照してください。
必要に応じて、代わりに、クリックの使用法でcls引数を指定してRichGroupまたはRichCommand使用できます。これは、変更されていないclickパッケージを並行して使用し続けることができることを意味します。
import click
from rich_click import RichCommand
@ click . command ( cls = RichCommand )
def main ():
"""My amazing tool does all the things."""例については、
examples/02_declarative.py参照してください。
rich-click CLI ツールrich-click には、 Click を使用するパッケージからの Click ヘルプ出力をフォーマットできる CLI ツールが付属しています。
使用するには、通常のコマンドの前にrich-click付けます。たとえば、 awesometoolというパッケージからリッチ化された Click ヘルプ テキストを取得するには、次のコマンドを実行します。
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. このプロジェクトは MIT ライセンスに基づいてライセンスされています。
