Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ewels/rich-click
Format click help output nicely with rich.
https://github.com/ewels/rich-click
cli click colored coloured help python rich styled styles
Last synced: 30 days ago
JSON representation
Format click help output nicely with rich.
- Host: GitHub
- URL: https://github.com/ewels/rich-click
- Owner: ewels
- License: mit
- Created: 2022-02-09T21:04:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T02:34:35.000Z (5 months ago)
- Last Synced: 2024-06-11T20:10:40.238Z (5 months ago)
- Topics: cli, click, colored, coloured, help, python, rich, styled, styles
- Language: Python
- Homepage: https://ewels.github.io/rich-click/
- Size: 8.5 MB
- Stars: 571
- Watchers: 4
- Forks: 33
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Richly rendered command line interfaces in click.
---
Documentation  ·  Source Code  ·  Changelog
---
**rich-click** is a shim around [Click](https://click.palletsprojects.com/) that renders help output nicely using [Rich](https://github.com/Textualize/rich).
- Click is a _"Python package for creating beautiful command line interfaces"_.
- Rich is a _"Python library for rich text and beautiful formatting in the terminal"_.
The intention of `rich-click` is to provide attractive help output from
Click, formatted with Rich, with minimal customisation required.
## Features
- 🌈 Rich command-line formatting of click help and error messages
- 😌 Same API as Click: usage is simply `import rich_click as click`
- 💫 Nice styles by default
- 💻 CLI tool to run on _other people's_ tools (prefix the command with `rich-click`)
- 📦 Export help text as HTML or SVG
- 🎁 Group commands and options into named panels
- ❌ Well formatted error messages
- 🔢 Easily give custom sort order for options and commands
- 🎨 Extensive customisation of styling and behaviour possible
## Installation
```shell
pip install rich-click
```
[Read the docs](https://ewels.github.io/rich-click#installation) for all supported installation methods.
## Examples
### Simple Example
To use rich-click in your code, replace `import click` with `import rich_click as click` in your existing click CLI:
```python
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 from [`examples/11_hello.py`](examples/11_hello.py)_
### More complex example
_Screenshot from [`examples/03_groups_sorting.py`](examples/03_groups_sorting.py)_
## Usage
This is a quick overview of how to use **rich-click**. [Read the docs](https://ewels.github.io/rich-click) for more information.
There are a couple of ways to begin using `rich-click`:
### Import `rich_click` as `click`
Switch out your normal `click` import with `rich_click`, using the same namespace:
```python
import rich_click as click
```
That's it! ✨ Then continue to use Click as you would normally.
> See [`examples/01_simple.py`](https://github.com/ewels/rich-click/blob/main/examples/01_simple.py) for an example.
### Declarative
If you prefer, you can use `RichGroup` or `RichCommand` with the `cls` argument in your click usage instead.
This means that you can continue to use the unmodified `click` package in parallel.
```python
import click
from rich_click import RichCommand
@click.command(cls=RichCommand)
def main():
"""My amazing tool does all the things."""
```
> See [`examples/02_declarative.py`](https://github.com/ewels/rich-click/blob/main/examples/02_declarative.py) for an example.
### `rich-click` CLI tool
**rich-click** comes with a CLI tool that allows you to format the Click help output from _any_ package that uses Click.
To use, prefix `rich-click` to your normal command.
For example, to get richified Click help text from a package called `awesometool`, you could run:
```console
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below..
```
## License
This project is licensed under the MIT license.