Metadata-Version: 2.2
Name: altcolor
Version: 0.0.5
Summary: A package designed to add color to text in console based applications. **[Credit to [colorama]('https://pypi.org/project/colorama/') for a few of the colors**
Home-page: https://github.com/TaireruLLC/altcolor
Author: Taireru LLC
Author-email: tairerullc@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


# AltColor 

**AltColor** is a Python package designed to add color to text in console-based applications, making it easy to create visually appealing outputs.

---

## Predefined Colors
AltColor provides a variety of predefined colors for your text, some of which are credited to [Colorama](https://pypi.org/project/colorama/). These predefined colors include:

- **Standard Colors**:  
  `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE`  

- **Light Colors**:  
  `LIGHTBLACK`, `LIGHTRED`, `LIGHTGREEN`, `LIGHTYELLOW`, `LIGHTBLUE`, `LIGHTMAGENTA`, `LIGHTCYAN`, `LIGHTWHITE`  

Additionally, you can define custom RGB colors for even more flexibility!

---

## Installation

Install AltColor via pip:

```bash
pip install altcolor
```

---

## Example Code

```python
# Imports
# Imports
from altcolor import colored_text, leaked_text, reset, cPrint, init; init(show_credits=True)

# Code

# Colored text allows you to paint your words with RGB
print(colored_text((244, 5, 7), "Hello World!"))

# Here's a regular print
print("Hello World!")

# We even have predefined colors
print(colored_text("BLUE", "Hello World!"))


# Leaked text splills into other print statements until you use reset()
print(leaked_text("RED", "Hey,"))
print("you")
print("are" + reset())

# Leaked text can even spill into the background
print(leaked_text("WHITE", "cool!", "Back"))
print("How")
print("are")
print("you?" + reset())

# You can also use cPrint
cPrint(color="RED", text="Hello World!", objective="controlled")
print("Hello World!")
cPrint(color="RED", text="Hello World!", objective="leaked")
print("Hello World!" + reset())
print("Hello World!")
```

---

### Key Features:

1. **Colored Text with RGB**: Use custom RGB values to style your text.
2. **Predefined Colors**: Quickly style text with easy-to-use predefined colors.
3. **Leaked Text**: Color spills into subsequent output until explicitly reset.
4. **Background Color**: Apply color to text backgrounds.
5. **Controlled Printing**: Use `cPrint` for precise and formatted color control.
6. **Credits Display**: Show credits for the package. (optional using `init(show_credits=True)`)

---

### Links
- **PyPI:** [AltColor on PyPI](https://pypi.org/project/altcolor/)
- **GitHub:** [AltColor Repository](https://github.com/your-repository-url)

---

Happy coding, and bring your console to life with **AltColor**!
