Metadata-Version: 2.4
Name: toradb
Version: 0.1.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: sentence-transformers ; extra == 'embeddings'
Requires-Dist: openai ; extra == 'openai'
Provides-Extra: embeddings
Provides-Extra: openai
License-File: LICENSE
Summary: Retrieval-focused database for local text, vector, and hybrid search — with a Python SDK, CLI, and retrieval SQL.
Keywords: search,retrieval,vector-database,bm25,hybrid-search,embeddings,rag
Author-email: Sophat Vathana <sovathana@slash.co>
License-Expression: Apache-2.0
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/sophatvathana/toradb/blob/main/CHANGELOG.md
Project-URL: Documentation, https://toradb.mintlify.app
Project-URL: Homepage, https://github.com/sophatvathana/toradb
Project-URL: Issues, https://github.com/sophatvathana/toradb/issues
Project-URL: PyPI, https://pypi.org/project/toradb/
Project-URL: Repository, https://github.com/sophatvathana/toradb

# ToraDB

Retrieval-focused database for local text, vector, and hybrid search — with a Python SDK, CLI, and retrieval SQL.

![ToraDB platform](docs/readme.png)

## Features

- **Local on-disk tables** — Parquet segments, index sidecars, WAL replay
- **Text, vector, hybrid** — BM25, dense ANN (HNSW / DiskANN), fusion
- **SQL + SDK** — `SELECT` with sparse/vector search, GROUP BY, materialized views
- **CLI** — ingest, query, reindex, catalog helpers

## Quick start

Install from [PyPI](https://pypi.org/project/toradb/):

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install toradb

toradb smoke
```

Clone the repo to run the bundled example:

```bash
git clone https://github.com/sophatvathana/toradb.git
cd toradb
python examples/full_example.py
```

To hack on ToraDB itself, see [Install](mdx/install.mdx) (build from source with `maturin develop`).

## Documentation

| Topic | Link |
|-------|------|
| **PyPI** | [pypi.org/project/toradb](https://pypi.org/project/toradb/) |
| **Docs site** | [toradb.mintlify.app](https://toradb.mintlify.app) *(Mintlify; update URL after deploy)* |
| GitHub hub | [docs/README.md](docs/README.md) |
| Install | [mdx/install](mdx/install.mdx) or published `/install` |
| Quickstart | [mdx/quickstart](mdx/quickstart.mdx) or published `/quickstart` |
| Contributing | [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) |
| Security | [docs/SECURITY.md](docs/SECURITY.md) |

Edit the docs site: `cd mdx && mint dev` — see [mdx/README.md](mdx/README.md).

## Development

```bash
cargo test
pytest tests/python_smoke.py -q
```

## Platform Dashboard (Rust API + UI)

```bash
cd apps/platform && pnpm install && pnpm build
cd ../..
cargo run -p toradb-cli --bin toradb-ingest -- platform serve --db examples/_demo_db --static-dir apps/platform/out --addr 127.0.0.1:8787
```

Open `http://127.0.0.1:8787` for the embedded dashboard + API server.

## License

Licensed under the [Apache License, Version 2.0](LICENSE).

