Skip to main content

colorex-py is a simple and flexible Python Module that provides an easy way to style your terminal output with color and text formatting. With support for both RGB and HEX color codes, as well as text styles like bold, italic, underline, strikethrough, and more, it makes your terminal applications visually more appealing and readable.

Project description

colorex-py

colorex-py is a simple and flexible Python Module that provides an easy way to style your terminal output with color and text formatting. With support for both RGB and HEX color codes, as well as text styles like bold, italic, underline, strikethrough, and more, it makes your terminal applications visually more appealing and readable.

Features

  • RGB Color Support: Define colors using RGB values (e.g., color_rgb(255, 0, 0)).
  • HEX Color Support: Use HEX color codes (e.g., color_hex("#FF0000")).
  • Text Styles: Bold, italic, underline, strikethrough, dim, and inverted text.
  • Background Colors: Set the background color using RGB or HEX.
  • Chainable API: Apply multiple styles in a single statement using method chaining.

Installation

To install colorex-py, you can use pip:

pip install colorex-py

Usage

Here's how you can use colorex to add color and styles to your terminal output:

import colorex

# Basic color usage
print(f"{}", "Hello, World!".color("0,255,0"))  # Green text
print(f"{}", "Error!".color("#FF0000"))         # Red text

# Text styles
print(f"{}", "Bold Text".bold())                # Bold text
print(f"{}", "Italic Text".italic())            # Italic text
print(f"{}", "Underlined Text".underline())     # Underlined text
print(f"{}", "Strikethrough Text".strikethrough()) # Strikethrough text
print(f"{}", "Dim Text".dim());                  # Dim text
print(f"{}", "Inverted Text".invert())          # Inverted (background) text

# Background color
print(f"{}", "Background Color".bg_color("0,0,255")) # Blue background

# Combining multiple styles
print(f"{}", "ALL".color("0,255,0").bold().italic().underline().strikethrough().dim().invert().bg_color("0,0,255")) # All styles

Supported Styles

  • Color: RGB and HEX color formats.
  • Text Styles:
    • bold()
    • italic()
    • underline()
    • strikethrough()
    • dim()
    • invert()
  • Background Colors: bg_color() with RGB or HEX values.

Example Output

The following example would result in a green-colored "Hello, World!" and a red "Error!" message in the terminal.

print(f"{}", "Hello, World!".color("0,255,0"))  # Green text
print(f"{}", "Error!".color("#FF0000"))         # Red text

Supported Color Formats

  • RGB: "r,g,b" (e.g., "255,0,0" for red).
  • HEX: "#RRGGBB" (e.g., "#FF0000" for red).

License

This project is licensed under the MPL-2.0 License - see the LICENSE file for details.

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

colorex_py-0.1.4.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

colorex_py-0.1.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file colorex_py-0.1.4.tar.gz.

File metadata

  • Download URL: colorex_py-0.1.4.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.10.16 Linux/6.8.0-1020-azure

File hashes

Hashes for colorex_py-0.1.4.tar.gz
Algorithm Hash digest
SHA256 296889f056988e40d3dbcb9ef116ec796bd3cb7694cd22198128d42d8384729d
MD5 57edd60a75ab77e97a04e49a88dca754
BLAKE2b-256 7a48c4c2f765f5cca8f51541c0e7219126f9b5707913499c7de0a497ac7b2811

See more details on using hashes here.

File details

Details for the file colorex_py-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: colorex_py-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.10.16 Linux/6.8.0-1020-azure

File hashes

Hashes for colorex_py-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7d3c6819333d5b56a1ba554f0a51151930a93dfa47da445b9d26152362722e5f
MD5 a1247a56455a936a405f361112f4fc24
BLAKE2b-256 534d25390c4ae3c09f2fb196e3a9d716b6b6842d668e2b1b1a219110840cb52e

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