Metadata-Version: 2.4
Name: xulbux
Version: 2.0.0
Summary: A modern, high-performance Python library to simplify common tasks.
Author-email: XulbuX <hi@xul.is>
Maintainer-email: XulbuX <hi@xul.is>
License-Expression: MIT
Project-URL: Bug Reports, https://github.com/xulbux/python-lib-xulbux/issues
Project-URL: Changelog, https://xulbux.github.io/python-lib-xulbux/changelog
Project-URL: Documentation, https://xulbux.github.io/python-lib-xulbux/docs
Project-URL: Homepage, https://xulbux.github.io/python-lib-xulbux
Project-URL: License, https://github.com/xulbux/python-lib-xulbux/blob/main/LICENSE
Project-URL: Source Code, https://github.com/xulbux/python-lib-xulbux
Project-URL: Stats, https://clickpy.clickhouse.com/dashboard/xulbux
Keywords: color,console,data-structures,file-system,formatting,string-manipulation,styling,utility
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prompt_toolkit>=3.0.41
Requires-Dist: regex>=2023.10.3
Requires-Dist: typing-extensions>=4.10.0; python_version < "3.13"
Provides-Extra: dev
Requires-Dist: mutmut>=3.7; extra == "dev"
Requires-Dist: pyright>=1.1.411; extra == "dev"
Requires-Dist: pytest>=9.0; extra == "dev"
Requires-Dist: pytest-cov>=7.0; extra == "dev"
Requires-Dist: ruff>=0.16; extra == "dev"
Dynamic: license-file

<span id="top" />

<div align="center">
<br><br>
<h1>
<a href="https://xulbux.github.io/python-lib-xulbux"><img height="96" src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/logo.svg"></a>
<br>
Python library <code>xulbux</code>
<br><br>
<a href="https://pypi.org/project/xulbux"><img src="https://img.shields.io/pypi/v/xulbux?style=flat&labelColor=404060&color=7075FF"/></a> <a href="https://clickpy.clickhouse.com/dashboard/xulbux"><img src="https://img.shields.io/pepy/dt/xulbux?style=flat&labelColor=404060&color=7075FF"/></a> <a href="https://github.com/xulbux/python-lib-xulbux/blob/main/LICENSE"><img src="https://img.shields.io/github/license/xulbux/python-lib-xulbux?style=flat&labelColor=404060&color=A6A8FF"/></a> <a href="https://github.com/xulbux/python-lib-xulbux/commits"><img src="https://img.shields.io/github/last-commit/xulbux/python-lib-xulbux?style=flat&labelColor=554046&color=FF6680"/></a> <a href="https://github.com/xulbux/python-lib-xulbux/issues"><img src="https://img.shields.io/github/issues/xulbux/python-lib-xulbux?style=flat&labelColor=554046&color=FF6680"/></a> <a href="https://github.com/xulbux/python-lib-xulbux/stargazers"><img src="https://img.shields.io/github/stars/xulbux/python-lib-xulbux?label=★&style=flat&labelColor=554046&color=FF8FA2"/></a>
</h1>
<h3>A modern, high-performance Python library to simplify common tasks.</h3>
<br><br>
</div>

**`xulbux`** is a modern, high-performance Python library compiled to C using MyPyC.<br>
It provides a clean, unified suite of utilities for typed terminal styling, color space manipulation, data processing, file system operations, and system automation.

<br>

> <br>
> <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/globe-code.svg" width="16" height="16" alt="" /> <b>Official Website:</b> Visit <a href="https://xulbux.github.io/python-lib-xulbux"><b>xulbux.github.io/python-lib-xulbux</b></a><br>
> <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/code-xml.svg" width="16" height="16" alt="" /> <b>Live Example:</b> Check out the <a href="https://xulbux.github.io/python-lib-xulbux/docs/guide/get-started#example-usage"><b>example CLI color converter</b></a> with live terminal preview.<br>
> <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/square-text.svg" width="16" height="16" alt="" /> <b>API Reference:</b> Explore all modules in the <a href="https://xulbux.github.io/python-lib-xulbux/docs"><b>API Documentation</b></a>.
> <br><br>

<br>
<br>

<span id="installation" />

## Installation <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/package.svg" width="28" height="28" alt="" />

It is recommended to install the library within a [virtual environment](https://docs.python.org/3/tutorial/venv.html) to align with modern Python standards and prevent `externally-managed-environment` errors on newer operating systems.

To install the library, run:

```bash
pip install xulbux
```

To upgrade to the latest available version:

```bash
pip install --upgrade xulbux
```

<br>

<span id="quick-start" />

## Quick Start <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/zap.svg" width="28" height="28" alt="" />

```python
import xulbux as xx
from xulbux import S

# Operator-based terminal styling:
(S.BOLD | S.BR.BLUE)("Hello from xulbux!").print()

# Interactive terminal box:
xx.console.box("Ready to build something great.")
```

For full usage guides, visit the [**Getting Started Guide**](https://xulbux.github.io/python-lib-xulbux/docs/guide/get-started) and [**CLI Tools Guide**](https://xulbux.github.io/python-lib-xulbux/docs/guide/cli-tools).

<br>
<br>
<br>

<span id="feedback" />

## Enjoying this library? Have suggestions? <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/heart-handshake.svg" width="28" height="28" alt="" />

Please consider giving a <img src="https://raw.githubusercontent.com/xulbux/python-lib-xulbux/main/assets/icons/star.svg" width="16" height="16" alt="star" /> on [**GitHub**](https://github.com/xulbux/python-lib-xulbux) or suggesting improvements in the [**Discussions**](https://github.com/xulbux/python-lib-xulbux/discussions).

<br>
<br>
<br>

---

✨ Always creating more cool stuff for you! ✨ —⠀[**XulbuX**](https://xulbux.com)
