Choose a package¶
VERA is one project composed of independently installable packages. Start with the package that owns the capability you need.
| Package | Install name | Import or command | Use it for |
|---|---|---|---|
| vera-doc | vera-doc |
import vera_doc |
Creating, storing, and searching .vera archives |
| vera-ingest | vera-ingest |
import vera_ingest |
Conversion registry, shared types, and archive writing |
| vera-ingest-pymupdf | vera-ingest-pymupdf |
import vera_ingest_pymupdf |
Default PyMuPDF PDF parsing and Tesseract OCR |
| vera-ingest-docling | vera-ingest-docling |
import vera_ingest_docling |
Optional Docling HybridChunker ingest (CLI extra; not bundled in the installer) |
| vera-embed-openai | vera-embed-openai |
import vera_embed_openai |
Official OpenAI embeddings plugin (bundled in CLI and the desktop sidecar) |
| vera | vera |
vera / import vera_cli |
Shell workflows and retrieval evaluation |
| vera-mcp | vera-mcp |
vera mcp / import vera_mcp |
Exposing VERA retrieval to MCP clients |
| vera-app | vera-app |
Desktop application | Interactive conversion, search, and grounded answers |
| vera-lab | vera-lab (dev) |
vera-lab / import vera_lab |
Contributor HTML layout lab for ingest pipelines |
Dependency direction¶
vera-ingest-pymupdf ──> vera-ingest ─┐
vera-ingest-docling ──> vera-ingest ─┤
vera-embed-openai ───────────────────┤
vera ─────────────────────────────────┼──> vera-doc
vera-app ─────────────────────────────┤
vera-mcp ─────────────────────────────┤
vera-lab (dev only) ──────────────────┘
vera-doc is the storage and retrieval foundation. The other packages compose
it without moving their own responsibilities into the core library.
Documentation model¶
Each package section contains the documentation appropriate for its public surface:
- Python libraries include API reference generated from source docstrings.
- The CLI emphasizes commands, output contracts, and recipes.
- MCP emphasizes client configuration and tool contracts.
- The desktop app emphasizes installation and user workflows rather than treating its private sidecar modules as a supported public API.
Shared format specifications and contributor architecture remain outside the
package sections because they describe the repository and .vera format as a
whole.