Metadata-Version: 2.4
Name: preburner
Version: 0.0.0
Summary: Portable, embeddable local AI runtime for private on-device agents.
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: llm,inference,local,on-device,structured-output,metal
Author: Preburner
Author-email: info@preburner.io
Maintainer: Preburner
Maintainer-email: info@preburner.io
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Rust
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Typing :: Typed
Project-URL: Homepage, https://github.com/preburner/preburner
Project-URL: Repository, https://github.com/preburner/preburner
Project-URL: issues, https://github.com/preburner/preburner/issues
Description-Content-Type: text/markdown

# Preburner

**Portable, embeddable local AI runtime for private on-device agents.**

[![PyPI version](https://img.shields.io/pypi/v/preburner.svg)](https://pypi.org/project/preburner/)
[![Python versions](https://img.shields.io/pypi/pyversions/preburner.svg)](https://pypi.org/project/preburner/)
[![License](https://img.shields.io/pypi/l/preburner.svg)](https://pypi.org/project/preburner/)

---

## Status — read this first

This release (`0.0.0`) is the **distribution scaffold**. It carries no engine
and no inference API; nothing should depend on it.

Preburner is a Rust LLM inference engine focused on batch-1 decode speed, cold
start, and memory footprint on Apple Silicon (Metal), NVIDIA, and later
Vulkan/Android. Its Python binding is a compiled PyO3/abi3 wheel that publishes
as **`0.1.0` and later** under this same name. Installing that version replaces
this one:

```bash
pip install --upgrade preburner
```

---

## Installation

```bash
pip install preburner
```

---

## Quick Start

What the current release supports is self-description:

```python
from preburner import about

info = about()

print(info["name"])          # preburner
print(info["organisation"])  # Preburner
print(info["version"])       # the installed version
```

```python
from preburner import __version__, __version_info__

print(__version__)                    # '0.0.0'
print(__version_info__ < (0, 1, 0))   # True — the engine owns 0.1.0+
```

---

## Command-Line Interface

```bash
# Human-readable report
preburner

# Machine-readable report
preburner --json

# Show version
preburner --version

# Help
preburner --help
```

`python -m preburner` works identically.

---

## API Reference

### `about() -> dict[str, str]`

Describe this distribution.

**Returns:**

- `dict[str, str]`: a mapping of `name`, `version`, `organisation`, `status`,
  `summary`, `license`, `homepage` and `contact`.

Every value is read from the package's version module, except `version`, which
comes from the installed distribution metadata — so on a machine running the
real engine wheel it reports `0.1.0` or later.

---

## Requirements

- Python >= 3.10, < 4.0
- No runtime dependencies

---

## License

Apache-2.0. Copyright © 2026 Preburner.

---

## Links

- **Homepage**: [https://github.com/preburner/preburner](https://github.com/preburner/preburner)
- **PyPI**: [https://pypi.org/project/preburner/](https://pypi.org/project/preburner/)

---

## Support

For questions and support, please contact
[info@preburner.io](mailto:info@preburner.io).

---

**Made with ♥ by Preburner**

