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:

from colorex import stylize

# Example usage
print(stylize("Hello, World!").color("0,255,0"))  # Green text
print(stylize("Error!").color("#FF0000"))  # Red text

print(stylize("Bold Text").bold())  # Bold text
print(stylize("Italic Text").italic())  # Italic text
print(stylize("Underlined Text").underline())  # Underlined text
print(stylize("Strikethrough Text").strikethrough())  # Strikethrough text
print(stylize("Dim Text").dim())  # Dim text
print(stylize("Inverted Text").invert())  # Inverted background text

print(stylize("Background Color").bg_color("0,0,255"))  # Blue background

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

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(stylize("Hello, World!").color("0,255,0"))  # Green text
print(stylize("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.5.tar.gz (7.4 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.5-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: colorex_py-0.1.5.tar.gz
  • Upload date:
  • Size: 7.4 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.5.tar.gz
Algorithm Hash digest
SHA256 ab0f826c4f83a0a7bd72ef5352b29bf7b445ca9127c42f826b481fbad3d4b5b6
MD5 b206fcdadafbe37a1b339cc8efbbf4a2
BLAKE2b-256 d7903b3fee3a6245e43760e6fc436e43f1acdc21097fa9e966345773c300c3c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: colorex_py-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 8.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 717bb2440c17cf62e19da35a10ca7467c41e03cdb7a6fea8e9c5070eb4529f0e
MD5 b6afe28c4fdac6bba34bcca830fe8a2e
BLAKE2b-256 126297c1bc3c8bfdfb414afbe5e9bba4ede8a339d3dfe723c2ff225b16f91dcf

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