Metadata-Version: 2.4
Name: turboterm
Version: 0.1.3
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
License-File: LICENSE
Requires-Python: >=3.11
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/valentinstn/turboterm/blob/main/CHANGELOG.md
Project-URL: Repository, https://github.com/valentinstn/turboterm

<h1 align="center">TurboTerm</h1>
<p align="center">
    <em>⚡ A high-performance terminal styling and CLI toolkit for Python, written in Rust 🦀</em>
</p>

<p align="center">
    <img src="https://raw.githubusercontent.com/valentinstn/turboterm/main/assets/example.png" alt="Example output" width="500">
</p>

Styled output, tables, and argument parsing — all three from a single Rust-backed import.
TurboTerm covers 90% of CLI use cases in a single package and aims to provide
the fastest possible performance with the smallest possible footprint.

<p align="center">
  <img src="https://raw.githubusercontent.com/valentinstn/turboterm/main/assets/benchmark.svg" alt="Import time comparison" width="500">
</p>
<p align="center">
  <img src="https://raw.githubusercontent.com/valentinstn/turboterm/main/assets/perf.svg" alt="Performance vs Rich" width="500">
</p>

## Installation

```
pip install turboterm
```

## Quickstart

```python
from turboterm import console
from turboterm.cli import Option, command, run

@command
def greet(
    name: str = Option(["--name", "-n"], default="World"),
):
    """Greet someone."""
    console.print(f"[bold]Hello, {name}![/bold]")

if __name__ == "__main__":
    run()
```

```
python app.py --name Alice
# Hello, Alice!

python app.py --help
```

For the full API reference see [USAGE.md](https://github.com/valentinstn/turboterm/blob/main/USAGE.md).

## Development

```bash
git clone https://github.com/valentinstn/turboterm.git
cd turboterm
uv run maturin develop
```

### Running tests

```bash
uv run python -m unittest discover tests
```

### Running benchmarks

```bash
uv run python scripts/benchmark.py    # full benchmark + regenerate charts
```

## License

MIT License

