Skip to main content

A gradient generator for the Rich library.

Project description

rich-gradient

Python Rye PyPI PyPI - Downloads

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, rich_gradient extends the rich standard colors to include:

  • 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

Rye (Recommended)

rye add rich-gradient

Pip

pip install rich-gradient

Usage

Basic Gradient Example

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

from rich.console import Console
from rich_gradient import Gradient

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

Hello, World!


Gradient 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

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

Specific Color Gradient Result

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.1.7.tar.gz (929.7 kB view details)

Uploaded Source

Built Distribution

rich_gradient-0.1.7-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rich_gradient-0.1.7.tar.gz
  • Upload date:
  • Size: 929.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.2

File hashes

Hashes for rich_gradient-0.1.7.tar.gz
Algorithm Hash digest
SHA256 6827488c55882f42797c871aaf118ea036909096b81780cbc4a2e72a0d1006b5
MD5 e88772e50ff7634d8bd507188e3c6292
BLAKE2b-256 5d99f68a368c4dcd354bf7922fad2a9249ebdd54da51f01e5fac7b2a84e0d01e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rich_gradient-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 26354928a153544ee9af6bf36478b23c5f5f73da1c22fc2af98905057798387d
MD5 d53ddb6dc17733ead74e98afabf46134
BLAKE2b-256 61136f3e13c588a6b7f1929a86b3a104b19297878e739c0bcd08046a5d7616b4

See more details on using hashes here.

Supported by

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