Skip to main content

A gradient generator for the Rich library.

Project description

rich-gradient

Python PyPI PyPI - Downloads uv

gradient example

This library is a wrapper of the great rich library that extends rich.text.Text to allow for the easy generation gradient text from either user entered colors or randomly if no colors are entered.

Borrowing from pydantic-extra-types' Color class As of v0.3.0, rich-gradient removed the color logic from rich-gradient and created rich-color-ext

  • 3 or 6 digit hex code (e.g. #f00 or #ff0000)
  • RGB color codes (e.g. rgb(255, 0, 0))
  • RGB tuples (e.g. (255, 0, 0))
  • CSS3 Color Names (e.g. red)

Read the docs at rich-gradient.readthedocs.io

Installation

uv (Recommended)

uv add rich-gradient

Pip

pip install rich-gradient

Usage

Basic Gradient Text Example

To print a simple gradient just substitute the Gradient class for the Text class in the rich-gradient library.

from rich.console import Console
from rich_gradient import Gradient

console = Console()
console.print(Gradient("Hello, World!")

Hello, World!


Gradient Text with Specific Colors

If you want a bit more control of the gradient, you can specify the colors you want to use in the gradient by passing them as a list of colors to the colors parameter.

Color Formats

Color can be parsed from a variety of formats including:

3 or 6 digit hex colors, rgb/rgba colors, and CSS3 Named Colors

Example Code

Specific Two-Color Gradient Example

console.print(
    Text(
        "This a gradient with two colors.",
        colors=["red", "orange"]
    ),
    justify="center"
)

Two Color Gradient


Specific Four-Color Gradient Example

console.print(
    Gradient(
        "This a gradient uses four specific colors.",
        colors=["red", "#ff9900", "#ff0", "Lime"],
        justify="center"
    )
)

Specific Color Gradient Result

multi-color specific colors


Rainbow Gradient Example

If four colors isn't enough, you can use the 'rainbow' parameter to generate a rainbow gradient that spans the entire spectrum of colors randomly.

console.print(
    Gradient(
        "This is a rainbow gradient.",
        rainbow=True,
        justify="center"
    )
)

Rainbow Gradient

*The rainbow gradient is generated randomly each time the code is run.


Still inherits from rich.text.Text

Since Gradient is a subclass of Text, you can still use all the same methods and properties as you would with Text.

console.print(
    Gradient(
        "This is an underlined rainbow gradient.",
        rainbow=True,
        style="underline"
    ),
    justify="center"
)
console.line()
console.print(
    Gradient(
        "This is a bold italic gradient.",
        style="bold italic"
    ),
    justify="center"
)
console.line()

Still Text

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rich_gradient-0.3.3.tar.gz (13.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rich_gradient-0.3.3-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file rich_gradient-0.3.3.tar.gz.

File metadata

  • Download URL: rich_gradient-0.3.3.tar.gz
  • Upload date:
  • Size: 13.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.3

File hashes

Hashes for rich_gradient-0.3.3.tar.gz
Algorithm Hash digest
SHA256 4351050e45fe4c23ed80448e13637aa15a72e2d998925c2234896529a209820e
MD5 f720c8c7a5c13a6c2ad19a4651e517ac
BLAKE2b-256 bd90fe0cd9d18358294c681beeb51bbeb3505f53c6fca1cc119f06d1ab51f3b7

See more details on using hashes here.

File details

Details for the file rich_gradient-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for rich_gradient-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b60a4163a97db288fb3abc1e2ba6ec7f4460781d4e15af75477330f3cfb15645
MD5 ae578324835ab4c3bc364f839990f120
BLAKE2b-256 7833d5b7f63a5e971c61a0fe411a51bfe6655614681190b5fd514db7462c695c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page