Metadata-Version: 2.5
Name: turbine-api
Version: 1.0.0
Summary: Contract-first read API for Turbine Data Products
Requires-Python: >=3.12
Requires-Dist: litestar>=2.15
Requires-Dist: msgspec>=0.21.1
Requires-Dist: pyarrow>=25.0.1
Requires-Dist: sqlglot>=29.0
Requires-Dist: turbine-core==1.0.0
Description-Content-Type: text/markdown

# turbine-api

`turbine-api` is a Turbine Extension. It adds a read-only Data API to `turbine serve`. The
API gives each published Dataset of a Data Contract as JSON, with filters, sort, and pages.
The routes and the fields come from the contract.

## Install

```console
uv add turbine-api "turbine-core[serve]"
uv run turbine serve
```

The API is at `/api/v1/data`. Its description in OpenAPI format is at
`/api/v1/data/docs/openapi.json`.
