Skip to main content

rich-struct

rich's print, with 21 popular editor themes and helpers for Markdown, JSON, YAML, XML, Python objects and tables (lists, numpy arrays, pandas DataFrames and Series).

pip install rich-struct          # add [yaml] to dump objects with print_yaml
from rich.markdown import Markdown
from rich.theme import Theme
from rich_struct import ThemeName, print, print_md, print_json, print_yaml, print_xml, print_object, print_syntax, print_table

print("[bold]hello[/bold]", {"a": 1})                 # drop-in rich.print, Tokyo Night by default
print(Markdown("## Printing structs"), theme=ThemeName.DRACULA)

print_md("# Title\n\n```python\nprint('hi')\n```")
print_json({"a": [1, 2, None]}, theme="Nord")         # enum value as a string works too
print_yaml("a: 1\nb: [x, y]")
print_xml("<a><b c='d'/></a>")
print_object(my_dataclass, theme=ThemeName.GITHUB_LIGHT)
print_syntax("SELECT 1", "sql")                       # any pygments lexer
print_table(df, title="Sales")                        # DataFrame, Series, numpy array, list...
print(df)                                             # arrays and frames become tables in print too

print_md("# Mine", theme=Theme({"markdown.h1": "bold magenta", "syntax.keyword": "red"}))

Every function takes theme=: a ThemeName, its string value, or a rich Theme. To change the theme for all of them at once, call set_default_theme("Dracula") (same accepted values; no argument resets to Tokyo Night). Passing None to any of them prints None (JSON: null) in the theme's colour for null values instead of failing. ThemeName.X.theme gives you the underlying rich Theme to use with your own Console.

Tables

print_table(data, title=None, max_rows=20, max_cols=10) accepts:

  • pandas DataFrame and Series, numpy arrays of any dimension (more than 2: one table per slice)
  • lists of dicts (records), lists of lists (a grid), and any other sequence such as array.array or range (one column)

Numbers are right-aligned, floats in a column share their decimals, and missing values are dimmed. Long data shows its head and tail around a … gap, and columns that don't fit the terminal width go into the gap as well. to_table(data) returns the renderable instead of printing it. numpy and pandas are not dependencies.

Themes

Dark Light
Tokyo Night (default) GitHub Light
Dracula Solarized Light
One Dark Pro One Light
Monokai Catppuccin Latte
Nord Gruvbox Light
Gruvbox Dark Tokyo Night Light
Catppuccin Mocha Ayu Light
Solarized Dark Night Owl Light
GitHub Dark Light+
Night Owl Everforest Light
Winter is Coming

Themes are built from each theme's colour palette, not ported token-by-token from the editor.

Output is painted on the theme's background across the full terminal width. Pass background=False to keep the terminal's own background; nothing is painted or padded when the output has no colour (e.g. piped to a file). A custom Theme gets a background by defining a background style, e.g. "background": "#c0caf5 on #1a1b26".

Code colours come from syntax.* styles (text, comment, keyword, string, number, function, type, tag, attribute, operator); a custom Theme may override any of them.

Metadata

Release files for rich-struct 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rich-struct 0.1.2
File Size Uploaded
rich_struct-0.1.2.tar.gz 12.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rich-struct 0.1.2
File Interpreter ABI Platform
rich_struct-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 24.6 kB

Release files / rich_struct-0.1.2.tar.gz

Download URL rich_struct-0.1.2.tar.gz
Size 12.6 kB
Tags Source
SHA-256 checksum
How to use checksums
85855deb527630e530b6f23a5ce06a29642af3df6c6dd0437e7b97613ae7e5a5
BLAKE2b-256 checksum
How to use checksums
277229e005acaf1f797f46ed1d53b6647cb2fb1b3cf8d452e237df7219f841af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / rich_struct-0.1.2-py3-none-any.whl

Download URL rich_struct-0.1.2-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f09a8833b73c811723a5ef76ba7e7a683f7399179043487a417bea40a4f4aca9
BLAKE2b-256 checksum
How to use checksums
027a3b7f67f680e15b5b56aa2f7ad53e4642482454ac117ae3fb732e5cf100a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.1.4

2 release files

0.1.3

2 release files

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page