Metadata-Version: 2.3
Name: cognee-community-vector-adapter-turbopuffer
Version: 0.1.0
Summary: Turbopuffer vector database adapter for cognee
Requires-Python: >=3.11,<=3.13
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: cognee (==0.5.3)
Requires-Dist: python-dotenv (>=1.0.0)
Requires-Dist: turbopuffer (>=0.5.0)
Description-Content-Type: text/markdown

# Cognee Turbopuffer Adapter

## Installation

If published, the package can be simply installed via pip:

```bash
pip install cognee-community-vector-adapter-turbopuffer
```

In case it is not published yet, you can use poetry to locally build the adapter package:

```bash
pip install poetry
poetry install # run this command in the directory containing the pyproject.toml file
```

## Connection Setup

1. Create an account at [turbopuffer.com](https://turbopuffer.com)
2. Get your API key from the [dashboard](https://turbopuffer.com/dashboard)
3. Set the `TURBOPUFFER_API_KEY` environment variable
4. Optionally set `TURBOPUFFER_REGION` (defaults to `gcp-us-central1`). See [available regions](https://turbopuffer.com/docs/regions).

## Usage

Import and register the adapter in your code:
```python
from cognee_community_vector_adapter_turbopuffer import register
```

Also, specify the dataset handler in the .env file:
```dotenv
VECTOR_DATASET_DATABASE_HANDLER="turbopuffer"
```

## Example
See example in `example.py` file.

