Metadata-Version: 2.3
Name: colorex-py
Version: 0.1.5
Summary: 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.
Author: LunaStev
Author-email: lunastev@gurmstudios.com
Requires-Python: >=3.5,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown

# 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:

```bash
pip install colorex-py
```

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

```python
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.

```python
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](LICENSE) file for details.
