Installing
Install with pip
or your favorite PyPI package manager.
python -m pip install rich
Run the following to test Rich output on your terminal:
python -m rich
Rich Print
To effortlessly add rich output to your application, you can import the rich print method, which has the same signature as the builtin Python function. Try this:
from rich import print
print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())
Rich REPL
Rich can be installed in the Python REPL, so that any data structures will be pretty printed and highlighted.
>>> from rich import pretty
>>> pretty.install()
Using the Console
For more control over rich terminal content, import and construct a Console object.
from rich.console import Console
console = Console()
The Console object has a print
method which has an intentionally similar interface to the builtin print
function. Here’s an example of use:
console.print("Hello", "World!")
As you might expect, this will print "Hello World!"
to the terminal. Note that unlike the builtin print
function, Rich will word-wrap your text to fit within the terminal width.
There are a few ways of adding color and style to your output. You can set a style for the entire output by adding a style
keyword argument. Here’s an example:
console.print("Hello", "World!", style="bold red")
The output will be something like the following:
That’s fine for styling a line of text at a time. For more finely grained styling, Rich renders a special markup which is similar in syntax to bbcode. Here’s an example:
console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")
You can use a Console object to generate sophisticated output with minimal effort. See the Console API docs for details.
Rich Inspect
Rich has an inspect function which can produce a report on any Python object, such as class, instance, or builtin.
>>> my_list = ["foo", "bar"]
>>> from rich import inspect
>>> inspect(my_list, methods=True)
See the inspect docs for details.
Rich CLI
See also Rich CLI for a command line application powered by Rich. Syntax highlight code, render markdown, display CSVs in tables, and more, directly from the command prompt.
Textual
See also Rich’s sister project, Textual, which you can use to build sophisticated User Interfaces in the terminal.
Projects using Rich
For some examples of projects using Rich, see the Rich Gallery on Textualize.io.
Would you like to add your own project to the gallery? You can! Follow these instructions.