rich click

Богато визуализированные интерфейсы командной строки одним щелчком мыши.

---

Документация · Исходный код · Журнал изменений

---

rich-click — это оболочка Click, которая хорошо отображает вывод справки с помощью Rich.

• Click — это «Пакет Python для создания красивых интерфейсов командной строки» .
• Rich — это «библиотека Python для форматированного текста и красивого форматирования в терминале» .

Цель rich-click — обеспечить привлекательный справочный вывод Click в формате Rich с минимальной необходимой настройкой.

Функции

• ? Расширенное форматирование командной строки для справки по кликам и сообщений об ошибках.
• ? Тот же API, что и для Click: использование просто import rich_click as click
• ? Хорошие стили по умолчанию
• Инструмент CLI для запуска на инструментах других людей (префикс команды rich-click )
• ? Экспортируйте текст справки в формате HTML или SVG.
• ? Группируйте команды и параметры в именованные панели.
• Хорошо отформатированные сообщения об ошибках
• ? Легко задавайте собственный порядок сортировки параметров и команд.
• ? Возможна обширная настройка стиля и поведения.

Установка

pip install rich-click

Прочтите документацию по всем поддерживаемым методам установки.

Примеры

Простой пример

Чтобы использовать rich-click в своем коде, замените import click на import rich_click as click в существующем интерфейсе командной строки 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 :

Импортировать rich_click как click

Отключите обычный импорт click с помощью rich_click , используя то же пространство имен:

 import rich_click as click

Вот и все! Затем продолжайте использовать Click, как обычно.

Пример см. в example examples/01_simple.py .

Декларативный

Если вы предпочитаете, вместо этого вы можете использовать RichGroup или RichCommand с аргументом cls при использовании кликов. Это означает, что вы можете продолжать использовать неизмененный пакет 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 .

инструмент CLI rich-click

rich-click поставляется с инструментом CLI, который позволяет форматировать вывод справки Click из любого пакета, использующего Click.

Чтобы использовать, добавьте префикс rich-click к вашей обычной команде. Например, чтобы получить расширенный текст справки Click из пакета awesometool , вы можете запустить:

$ rich-click awesometool --help

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

Лицензия

Этот проект лицензируется по лицензии MIT.