| single |
[Supported Python Versions] [PyPI version]
[Downloads]
[codecov]
[Rich blog]
[Twitter Follow]
![Logo]
[English readme]
• [简体中文 readme]
• [正體中文 readme]
• [Lengua española readme]
• [Deutsche readme]
• [Läs på svenska]
• [日本語 readme]
• [한국어 readme]
• [Français readme]
• [Schwizerdütsch readme]
• [हिन्दी readme]
• [Português brasileiro readme]
• [Italian readme]
• [Русский readme]
• [Indonesian readme]
• [فارسی readme]
• [Türkçe readme]
• [Polskie readme]
Rich is a Python library for _rich_ text and beautiful formatting in the
terminal.
The [Rich API] makes it easy to add color and style to terminal output.
Rich can also render pretty tables, progress bars, markdown, syntax
highlighted source code, tracebacks, and more — out of the box.
![Features]
For a video introduction to Rich see [calmcode.io] by [@fishnets88].
See what [people are saying about Rich].
## Compatibility
Rich works with Linux, OSX, and Windows. True color / emoji works with new
Windows Terminal, classic terminal is limited to 16 colors. Rich requires
Python 3.7 or later.
Rich works with [Jupyter notebooks] with no additional configuration
required.
## Installing
Install with `pip` or your favorite PyPI package manager.
```sh
python -m pip install rich
```
Run the following to test Rich output on your terminal:
```sh
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:
```python
from rich import print
print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())
```
![Hello World]
## Rich REPL
Rich can be installed in the Python REPL, so that any data structures will
be pretty printed and highlighted.
```python
>>> from rich import pretty
>>> pretty.install()
```
![REPL]
## Using the Console
For more control over rich terminal content, import and construct a
[Console] object.
```python
from rich.console import Console
console = Console()
```
|