Metadata-Version: 2.4
Name: alcove-search
Version: 0.3.0
Summary: Local-first document retrieval. Your data never leaves your disk.
Author-email: John Malone <john.malone@gmail.com>
License: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Keywords: chromadb,documents,local-first,retrieval,search
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Indexing
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4<5.0,>=4.12
Requires-Dist: chromadb<1.0,>=0.5.5
Requires-Dist: fastapi<1.0,>=0.115.0
Requires-Dist: jinja2<4.0,>=3.1
Requires-Dist: pypdf<5.0,>=4.3
Requires-Dist: python-multipart<1.0,>=0.0.6
Requires-Dist: uvicorn<1.0,>=0.30.0
Provides-Extra: dev
Requires-Dist: httpx>=0.27; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: python-docx>=1.0; extra == 'dev'
Provides-Extra: docx
Requires-Dist: python-docx>=1.0; extra == 'docx'
Provides-Extra: epub
Requires-Dist: ebooklib<1.0,>=0.18; extra == 'epub'
Provides-Extra: semantic
Requires-Dist: sentence-transformers>=3.0; extra == 'semantic'
Provides-Extra: zvec
Requires-Dist: zvec>=0.1; extra == 'zvec'
Description-Content-Type: text/markdown

Alcove

**Index your world. Share it with the universe.**

**Alcove** is a local-first document search library. Install it, point it at your files, and search. No server, no sign-up, no data leaves your disk.

> **[Watch the 30-second demo](https://pro777.github.io/alcove/demo.html)**

## ✨ Features

- **🔒 Private** — documents stay on your machine, no cloud calls, no telemetry
- **⚡ Zero config** — `pip install`, two commands, searching in under a minute
- **🔌 Extensible** — custom extractors, embedders, and vector backends
- **📄 Multi-format** — PDF, EPUB, HTML, Markdown, CSV, JSON, JSONL, DOCX, TXT
- **🌐 Web UI** — upload and search from your browser

## 📦 Installation

**Requirements:** Python 3.10+ · Linux, macOS, or Windows

```bash
pip install alcove-search
```

**Optional extras:**

| Extra | Install command | What it adds |
|-------|----------------|--------------|
| Semantic search | `pip install alcove-search[semantic]` | Real vector similarity via sentence-transformers (~80 MB model download on first use) |
| EPUB support | `pip install alcove-search[epub]` | `.epub` file ingestion |
| DOCX support | `pip install alcove-search[docx]` | `.docx` file ingestion |

## ⚡ Quick Start

```bash
alcove seed-demo          # download sample corpus + build index
alcove serve              # open http://localhost:8000
```

Alcove web UI

## 🔒 Trust Model

- Local disk only — no hosted control plane
- No telemetry. Period. (ChromaDB's upstream telemetry is also disabled.)
- You choose what enters your index
- **We do not want your data**

## 📚 Documentation

- [Architecture](docs/ARCHITECTURE.md)
- [Operations](docs/OPERATIONS.md)
- [Security](docs/SECURITY.md)
- [Seed Corpus](docs/SEED_CORPUS.md)
- [Roadmap](docs/ROADMAP.md)
- [Accessibility](ACCESSIBILITY.md)

## 📄 License

[Apache 2.0](LICENSE)
