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

Usage

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

import colorex

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

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

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

# Combining multiple styles
print("{}", "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("{}", "Hello, World!".color("0,255,0"))  # Green text
print("{}", "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.1.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.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: colorex_py-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 f71e8ea8d44b203f11bad3100df154be0310f671c6fa03596145a7d90f07bb2b
MD5 2ceb2172233713d06a8d899890d73d44
BLAKE2b-256 07e7fe1209faf5322db8626cde733859bde9da5d251a204696d0f537aef6a9be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: colorex_py-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3227945bcf917c7fa810c66136f36ddec0d7c630b4d970c494ce02c0aaeca7d9
MD5 aa396f7ab8de27f19610a03dfaa60d94
BLAKE2b-256 3e5c93c65533d27bcb4d041b6037c9ba7c335dd6a8e9fc569b922db877bcefdf

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