Metadata-Version: 2.4
Name: StyleUpText
Version: 0.2.0
Summary: The best method to style text. Better than Rich + colorama
Author-email: Arin Singla <contactarin@aplexon.com>
License-Expression: LicenseRef-Proprietary
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyfiglet>=1.0.2
Dynamic: license-file

# 🎨 StyleUpText

A high-performance, lightweight terminal text-styling engine that gives you pinpoint precision over your console typography. 

**StyleUpText** bridges the gap between competing CLI packages: it lets you change terminal colors instantly using real **Hex codes** and **24-bit Truecolor RGB**, while utilizing lightweight **BBCode tags** exclusively for text formatting (bold, italic, etc.) without the parsing overhead of heavier frameworks. Brought to you by [Aplexon](https://aplexon.com).

---

## 🚀 Key Advantages

*   **True Color Freedom:** Supports any Hex code (`#C42D76`) or RGB tuple directly. You are never restricted to primitive 8-color console palettes.
*   **Decoupled Architecture:** Colors are handled dynamically via execution functions, while text styles use clean BBCode tags (`[b]`, `[i]`, `[u]`, `[s]`). 
*   **Zero-Dependency Color Layer:** The color engine uses raw ANSI streams, ensuring lightweight deployment with zero background parsing overhead.

---

## 🛠️ Installation

Install the package directly via pip:

```bash
pip install StyleUpText
```

---

## 💻 Usage Examples

### 1. Hex & RGB Color Control (`color.py`)
Import the color sub-module to print precise truecolor lines or lock your terminal brush to a specific palette.

```python
from StyleUpText import color

# Print a specific line instantly using a hex code
color.Print_Line_Color_HEX("#C42D76", "This text is raspberry pink!")

# Lock the foreground color using RGB, print text, and reset
color.Color_RGB(196, 45, 118)
print("All of this text will render custom colored until reset...")
color.Reset_Color()

# Use built-in crisp presets
color.Print_Line_Color_RGB(3, 194, 252, "Built-in alternative line helper.")
color.Color("cyan", "Or print a preset line easily!")
```

### 2. BBCode Formatting (`style.py`)
Format your copy cleanly using semantic layout markers. Tags can be combined natively.

```python
from StyleUpText import style

# Format styles using lightweight structural tags
style.StylePrint("This is [b]bold[/b], this is [i]italic[/i], and this is [u]underlined[/u]!")
style.StylePrint("You can also apply [s]strikethrough text[/s] effortlessly.")
```

### 3. Decorative Big ASCII Typography
Render block headers using bundled typography matrices:

```python
from StyleUpText import style

# Print a styled headline banner
style.printFont("APLEXON", "slant")
```

---

## 🛠️ Built-in Terminal Commands

When you install **StyleUpText**, it automatically binds a native command directly to your machine's environment path. 

### Find Pyfiglet Fonts
Search through over 570+ stylized block fonts directly inside your workspace shell:

```bash
search-fonts <keyword>
```
*Example:* `search-fonts slant` will look up every accessible typography structure variation containing that name string.

---

## 📂 Project Directory Structure

Ensure your local production folder matches this tree layout:

```text
StyleUpText_Project/
├── pyproject.toml             # Configuration, dependencies, and shell scripts
├── README.md                  # This documentation manual
└── src/
    └── StyleUpText/             # Main distribution workspace module
        ├── __init__.py        # Exports package layout functions cleanly
        ├── color.py           # Hex, RGB, and palette engine
        └── style.py           # BBCode processing and ASCII typography
```

### Exposing Functions via `__init__.py`
To achieve the clean imports shown in the examples, place the following exposure declarations inside `src/StyleUpText/__init__.py`:

```python
from . import color
from . import style
```

---

## 🤝 Contributing & Support

This engine is actively maintained by **Arin** ([contactarin@aplexon.com](mailto:contactarin@aplexon.com)). For feature requests or project portfolios, visit [aplexon.com](https://aplexon.com).

**License:** Aplexon StyleUpText Non-Commercial & Revocable License Agreement. Free for personal use. To use it commercially you must get a license for free by asking **Arin** at ([contactarin@aplexon.com](mailto:contactarin@aplexon.com)). __**This software license is revokable.**__
