Skip to main content

Persistent, queryable AI memory for any Python app — local-first, zero API cost

Project description

retainr

CI

Persistent, queryable memory for any Python AI app — local-first, zero API cost.

PyPI version License: MIT Python 3.10+


What is it?

retainr gives any AI app a long-term memory layer — without needing an API key, a cloud service, or a database server.

Store things. Recall them semantically. Forget them. All locally.

from retainr import Memory

mem = Memory(user_id="arjun")

mem.remember("I prefer dark mode and use VS Code")
mem.remember("Currently building a job application assistant")
mem.remember("I like concise answers over long explanations")

results = mem.recall("what tools does the user prefer?")
for r in results:
    print(f"[{r['score']:.3f}] {r['text']}")
[0.412] I prefer dark mode and use VS Code
[0.289] I like concise answers over long explanations

CLI Demo

alt text

Stats

alt text


Install

pip install retainr

Features

  • 🧠 Semantic recall — finds memories by meaning, not exact keywords
  • 📉 Memory decay — old memories fade in relevance automatically
  • Importance scoring — weight memories by how significant they are
  • 🏷️ Tags — organize memories into namespaces
  • 🗑️ Forget & clear — GDPR-friendly deletion
  • 💾 Local-first — uses FAISS + SQLite, no external services
  • 🆓 Zero cost — no API keys, no cloud, runs on your machine

API Reference

Memory(user_id, db_path)

from retainr import Memory

mem = Memory(user_id="alice", db_path="memory.db")
Param Default Description
user_id "default" Isolates memories per user
db_path "memory.db" SQLite file path. Use ":memory:" for in-RAM (tests)

remember(text, tags, importance, decay_days)

Store a memory.

mid = mem.remember(
    "User just got promoted to SDE-2",
    tags=["career", "milestone"],
    importance=0.9,   # 0.0–1.0, default 0.5
    decay_days=90,    # score halves every 90 days, 0 = no decay
)

Returns: str — the memory ID (use it to forget() later)


recall(query, top_k)

Find the most semantically relevant memories.

results = mem.recall("what is the user's job status?", top_k=3)
# [{"id": ..., "text": ..., "score": 0.87, "tags": [...], ...}]

forget(memory_id)

Delete a specific memory.

mem.forget(mid)

clear()

Wipe all memories for this user.

mem.clear()

export(filepath)

Backup all memories to JSON.

mem.export("my_memories.json")

How it works

  1. remember() → text is embedded using sentence-transformers (all-MiniLM-L6-v2, runs locally) → vector stored in FAISS, metadata in SQLite
  2. recall() → query is embedded → FAISS finds top-k nearest vectors → SQLite returns the original text
  3. Scoring → final score = cosine similarity × (0.7 + 0.3 × decayed importance)

Why not mem0 / Zep / etc.?

retainr mem0 Zep
Local-first
API key needed
Cost Free Paid tiers Paid tiers
Memory decay
pip install

Stack


License

MIT © Devarajan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

retainr-0.3.0.tar.gz (205.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

retainr-0.3.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file retainr-0.3.0.tar.gz.

File metadata

  • Download URL: retainr-0.3.0.tar.gz
  • Upload date:
  • Size: 205.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.9

File hashes

Hashes for retainr-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d235da18fb7ada877d86bd0696c5d223796d5b291a2678b78aef850270733eef
MD5 020ecb635aff0d054e7a20702644af01
BLAKE2b-256 837c2e90a3ab94718da07ba52f02b4e14757c9f1e98d1c63f677b03575164afa

See more details on using hashes here.

File details

Details for the file retainr-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: retainr-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.9

File hashes

Hashes for retainr-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f705dcaad5458d5793f981c23d57eb6f31c15772ee96577e3147b5c27579dfb
MD5 ed498d8bc2934cf1c7af609c5352bbeb
BLAKE2b-256 04ef85988f534948729a81cab3455bfefd33f01950ed2f77f6555dc18c186814

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page