rich-color-ext 0.1.5

Extend Rich with the ability to parse CSS color names and 3-digit hex colors.

rich-color-ext

rich-color-ext extends the great rich library to be able to parse 3-digit hex colors (ie. #09F) and CSS color names (ie. rebeccapurple).

Installation

uv (recommended)

# via uv directly
uv add rich-color-ext

or

# or via pip through uv
uv pip add rich-color-ext

pip

pip install rich-color-ext

Usage

To make use of rich-color-ext all you need to do is import and install it at the start of your program:

from rich_color_ext import install
from rich.console import Console

install()  # Patch Rich's Color.parse method

console = Console(width=64)
console.print(
    Panel(
        "This is the [b #00ff99]rich_color_ext[/b #00ff99] \
example for printing CSS named colors ([bold rebeccapurple]\
rebeccapurple[/bold rebeccapurple]), 3-digit hex \
colors ([bold #f0f]#f0f[/bold #f0f]), and [b #99ff00]\
rich.color_triplet.ColorTriplet[/b #99ff00] & [b #00ff00]\
rich.color.Color[/b #00ff00] instances.",
        padding=(1,2)
    ),
    justify="center"
)

rich-gradient by Max Ludden

Packaging with PyInstaller

When bundling the project with PyInstaller you must include the JSON resource colors.json so it is available at runtime inside the bundle. There are two simple ways to do this.

1. Pass the file with the command-line option --add-data:

   • macOS / Linux (colon separator):

     pyinstaller --onefile --add-data "src/rich_color_ext/colors.json:rich_color_ext" your_entry_script.py
     

   • Windows (semicolon separator):

     pyinstaller --onefile --add-data "src\\rich_color_ext\\colors.json;rich_color_ext" your_entry_script.py
     

2. Add the file to the spec file's Analysis.datas list. Example snippet to paste into your .spec file:

   a = Analysis(
           ['your_entry_script.py'],
           pathex=[],
           binaries=[],
           datas=[('src/rich_color_ext/colors.json', 'rich_color_ext')],
           hiddenimports=[],
           hookspath=[],
           runtime_hooks=[],
           excludes=[],
           win_no_prefer_redirects=False,
           win_private_assemblies=False,
           cipher=None,
   )
   

Helper script

A small helper script is provided to build with PyInstaller and automatically choose the correct data separator for your platform. By default it builds the example src/rich_color_ext/cli.py entry script but you can pass any entry script as the first argument.

Usage:

./scripts/pyinstaller_build.sh [path/to/your_entry_script.py]  # src/rich_color_ext/cli.py