Skip to content

Installation

  • Python 3.9 or higher
  • pip, poetry, or uv package manager
Terminal window
pip install reminiscence

This installs Reminiscence with all core dependencies:

  • lancedb - Vector database for embeddings
  • fastembed - Fast embedding generation
  • orjson - Fast JSON serialization
  • pyarrow - Columnar data format
  • structlog - Structured logging

If you plan to cache pandas DataFrames or Polars DataFrames:

Terminal window
pip install "reminiscence[dataframes]"

If you want observability and metrics:

Terminal window
pip install "reminiscence[otel]"

Test that Reminiscence is installed correctly:

from reminiscence import Reminiscence, ReminiscenceConfig
# Create a cache instance
cache = Reminiscence()
# Verify it works
result = cache.lookup("test query", context={})
print(f"Installation successful! Cache miss: {not result.is_hit}")

You should see: Installation successful! Cache miss: True

If you want to contribute or modify Reminiscence:

Terminal window
# Clone the repository
git clone https://github.com/demiotic/reminiscence.git
cd reminiscence
Terminal window
pip install -e ".[dev]"
pytest

Now that Reminiscence is installed, check out the Quick Start guide to learn how to use it.