rich click

单击即可丰富呈现的命令行界面。

---

文档·源代码·变更日志

---

rich-click是一个围绕 Click 的垫片，它可以使用 Rich 很好地呈现帮助输出。

• Click 是一个“用于创建漂亮的命令行界面的 Python 包” 。
• Rich 是一个“在终端中实现富文本和漂亮格式的 Python 库” 。

rich-click的目的是通过 Click 提供有吸引力的帮助输出，并使用 Rich 进行格式化，并且需要最少的自定义。

特征

• ？单击帮助和错误消息的丰富命令行格式
• ？与 Click 相同的 API：用法只需import rich_click as click
• ？默认样式不错
• 在其他人的工具上运行的 CLI 工具（在命令前面加上rich-click ）
• ？将帮助文本导出为 HTML 或 SVG
• ？将命令和选项分组到命名面板中
• 格式正确的错误消息
• ？轻松为选项和命令提供自定义排序顺序
• ？可以对样式和行为进行广泛的定制

安装

pip install rich-click

阅读文档以了解所有支持的安装方法。

示例

简单的例子

要在代码中使用 rich-click，请将现有 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 ：

将rich_click导入为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附带一个 CLI 工具，允许您格式化任何使用 Click 的包中的 Click 帮助输出。

要使用，请在普通命令前添加rich-click前缀。例如，要从名为awesometool的包中获取丰富的 Click 帮助文本，您可以运行：

$ rich-click awesometool --help

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

执照

该项目已获得 MIT 许可。