rich click
v1.8.4
클릭 시 풍부하게 렌더링된 명령줄 인터페이스.
문서 · 소스 코드 · 변경 내역
rich-click은 Rich를 사용하여 도움말 출력을 멋지게 렌더링하는 Click 주변의 심입니다.
rich-click 의 목적은 최소한의 사용자 정의만으로 Rich로 형식화된 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 사용하는 방법에는 몇 가지가 있습니다.
click 으로 rich_click 가져오기 동일한 네임스페이스를 사용하여 rich_click 으로 일반 click 가져오기를 전환합니다.
import rich_click as click그게 다야! 그런 다음 평소처럼 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 이라는 패키지에서 풍부한 클릭 도움말 텍스트를 얻으려면 다음을 실행할 수 있습니다.
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. 이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다.
