Installation
Requirements
Section titled “Requirements”- Python 3.9 or higher
- pip, poetry, or uv package manager
Install Reminiscence
Section titled “Install Reminiscence”pip install reminiscencepoetry add reminiscenceuv add reminiscenceThis installs Reminiscence with all core dependencies:
lancedb- Vector database for embeddingsfastembed- Fast embedding generationorjson- Fast JSON serializationpyarrow- Columnar data formatstructlog- Structured logging
Optional Dependencies
Section titled “Optional Dependencies”For DataFrame Support
Section titled “For DataFrame Support”If you plan to cache pandas DataFrames or Polars DataFrames:
pip install "reminiscence[dataframes]"poetry add "reminiscence[dataframes]"uv add "reminiscence[dataframes]"For OpenTelemetry
Section titled “For OpenTelemetry”If you want observability and metrics:
pip install "reminiscence[otel]"poetry add "reminiscence[otel]"uv add "reminiscence[otel]"Verify Installation
Section titled “Verify Installation”Test that Reminiscence is installed correctly:
from reminiscence import Reminiscence, ReminiscenceConfig
# Create a cache instancecache = Reminiscence()
# Verify it worksresult = cache.lookup("test query", context={})print(f"Installation successful! Cache miss: {not result.is_hit}")You should see: Installation successful! Cache miss: True
Development Installation
Section titled “Development Installation”If you want to contribute or modify Reminiscence:
# Clone the repositorygit clone https://github.com/demiotic/reminiscence.gitcd reminiscencepip install -e ".[dev]"pytestpoetry install --with devpoetry run pytestuv sync --extra devuv run pytestNext Steps
Section titled “Next Steps”Now that Reminiscence is installed, check out the Quick Start guide to learn how to use it.