Skip to main content

Installation

Requirements​

  • Python 3.10+
  • No mandatory dependencies (pure Python)
  • Optional extras for advanced features

pip install​

pip install whoosh-ng

Extras​

ExtraDescription
vectorNumPy-based vector providers
autocompleteAutocomplete plugin
apiFastAPI plugin
metricsPrometheus metrics integration
allInstall everything
pip install whoosh-ng[all]

Development install​

git clone https://github.com/your-org/whoosh-NG.git
cd whoosh-NG
uv sync --extra dev

Verification​

uv run pytest tests/ -q
uv run ruff check src/ tests/
uv run ruff format --check .
uv run mypy src/whoosh

Next Steps​