Modern
Whoosh-NG is more than a fork — it is the evolution of Whoosh for modern Python applications. This section documents the optional, opt-in extensions that make Whoosh-NG production-ready in today's stacks: semantic vector search, a plugin architecture, a middleware pipeline, linguistics, and pluggable cloud storage.
All features here are optional extras: the core engine has zero mandatory third-party dependencies. Classic features live under Core.
Highlights
┌─────────────────────────────────────────────────────────────┐
│ Whoosh-NG Modern Extensions │
├─────────────────────────────────────────────────────────────┤
│ 🔌 Plugins → PluginManager, entry-point discovery │
│ 🧩 Middleware → cross-cutting indexing/search hooks │
│ 🧠 Vector Search → NumPy, HNSW, Faiss, Qdrant providers │
│ 🌐 Linguistics → synonyms, language-aware analyzers │
│ 🔤 Stemming → PyStemmer-backed provider system │
│ ☁️ Storage → S3, hybrid cache + remote backends │
│ ⚡ Performance → benchmarks and optimization guides │
└─────────────────────────────────────────────────────────────┘
Guides
| Guide | Description |
|---|---|
| Plugins | The plugin architecture and how to register extensions |
| Plugin System | PluginManager API and lifecycle |
| Middleware | The middleware base classes and context |
| Middleware & Plugin Pipeline | Compose cross-cutting concerns |
| Autocomplete | Autocomplete providers |
| Autocomplete Providers | NGram, Fuzzy, InvertedIndex backends |
| Vector Search | Semantic search with embeddings |
| Modern Indexing | BatchIndexWriter, AnalyzerCache |
| Monitoring | Metrics and observability |
| Performance | Benchmarking and optimization |
| Linguistics & Synonyms | SynonymManager and linguistic engine |
| Stemmer Providers | PyStemmer backends and auto-detection |
| Storage Providers | Hybrid, S3, and async storage backends |
| Auto-indexing | Schema discovery and data-source driven indexing |
| Provider Integration | End-to-end pipeline integration |
| Configuration Engine | Typed configuration surface |
Where to start
- New to Whoosh-NG? Begin with Core → Quickstart.
- Want semantic search? Jump to Vector Search.
- Building a web service? See Plugins and Storage Providers.
💡 Tip: the classic Stemming and N-grams guides now live under Core, since they are part of the original Whoosh feature set.