Metadata-Version: 2.4
Name: synthetic-ohlcv
Version: 0.1.2
Summary: Interactive synthetic OHLCV kline generator for learnable trading experiments.
Keywords: fastapi,klines,ohlcv,synthetic-data,trading
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.11
Requires-Dist: fastapi>=0.136.1
Requires-Dist: numpy<3,>=2.3.0
Requires-Dist: polars>=1.40.1
Requires-Dist: pydantic>=2.13.3
Requires-Dist: uvicorn>=0.46.0
Description-Content-Type: text/markdown

# Synthetic Klines

Standalone synthetic OHLCV kline generator for learnable trading experiments.

Requires Python 3.11 or newer.

## Installation

Install from PyPI with `pip`:

```bash
python -m pip install synthetic-ohlcv
```

Or install with `uv`:

```bash
uv pip install synthetic-ohlcv
```

## Run The App

After installation, run:

```bash
synthetic-ohlcv
```

Open `http://127.0.0.1:8100`.

For local development, you can also run:

```bash
uv run synthetic-ohlcv
```

Use a custom port when needed:

```bash
uv run synthetic-ohlcv --port 8110
```

## Python API

```python
from synthetic_ohlcv import SyntheticKlinesConfig, make_synthetic_ohlcv

frame = make_synthetic_ohlcv(SyntheticKlinesConfig(rows=4_000, seed=43))
```

Generated datasets contain exactly:

```text
timestamp, open, high, low, close, volume, turnover
```
