imprint-mem 0.1.0__tar.gz

imprint_mem-0.1.0/.env.example

@@ -0,0 +1,12 @@
+# Imprint reads environment variables from .env via just's dotenv-load.
+# Copy this file to .env and fill in values. .env is gitignored.
+#
+#   cp .env.example .env
+
+# Required for the LLM pipeline and `just test-live`.
+# Get one at https://console.anthropic.com/settings/keys
+ANTHROPIC_API_KEY=
+
+# Required for imprint[voyage] live tests (VoyageEmbedder, VoyageTokenCounter).
+# Get one at https://dash.voyageai.com/api-keys
+VOYAGE_API_KEY=

imprint_mem-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - run: uv sync --locked
+
+      - run: uv run ruff check --output-format=github .
+      - run: uv run ruff format --check .
+      - run: uv run pyright
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+
+      - run: uv sync --locked
+
+      - run: uv run pytest

imprint_mem-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+.venv/
+__pycache__/
+*.py[cod]
+*$py.class
+
+.pytest_cache/
+.ruff_cache/
+.pyright_cache/
+.coverage
+htmlcov/
+
+dist/
+build/
+*.egg-info/
+
+# Local SQLite databases
+*.db
+*.db-journal
+*.db-wal
+*.db-shm
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store
+
+# Local env
+.env
+.env.*
+!.env.example

imprint_mem-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14.4

imprint_mem-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Rami Kader
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

imprint_mem-0.1.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: imprint-mem
+Version: 0.1.0
+Summary: A Python library that gives AI agents memory.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: aiosqlite>=0.20
+Requires-Dist: pydantic-ai-slim[anthropic]>=0.0.14
+Requires-Dist: pydantic>=2.7
+Provides-Extra: all
+Requires-Dist: imprint[anthropic-tokens,online,vector,voyage]; extra == 'all'
+Provides-Extra: anthropic-tokens
+Requires-Dist: anthropic>=0.40; extra == 'anthropic-tokens'
+Provides-Extra: online
+Requires-Dist: river>=0.22; extra == 'online'
+Provides-Extra: vector
+Requires-Dist: sqlite-vec>=0.1.6; extra == 'vector'
+Provides-Extra: voyage
+Requires-Dist: numpy>=1.26; extra == 'voyage'
+Requires-Dist: voyageai>=0.3; extra == 'voyage'
+Description-Content-Type: text/markdown
+
+<h1>
+  <picture><source media="(prefers-color-scheme: dark)" srcset="docs/media/mark-dark.svg"><img src="docs/media/mark-light.svg" width="48" alt="" valign="middle" /></picture>&nbsp;imprint
+</h1>
+
+Detect, distill, compile. Memory for AI agents.
+
+Not a database of past conversations. A system that detects what matters in
+interactions, distills it into typed memories (facts, rules, decisions, context),
+consolidates redundant or contradicted memories as new ones arrive, and compiles
+a behavioral policy the agent injects into its prompt. The library is
+self-contained: SQLite for storage, pydantic-ai for LLM calls.
+
+## Install
+
+```sh
+pip install imprint
+```
+
+Optional extras:
+
+```sh
+pip install imprint[vector]           # SQLiteVecStore for dense retrieval
+pip install imprint[voyage]           # VoyageEmbedder and VoyageTokenCounter
+pip install imprint[anthropic-tokens] # exact token counting via the Anthropic API
+pip install imprint[online]           # FSRSGradientDecay via River
+pip install imprint[all]              # everything above
+```
+
+## Quick example
+
+```python
+from imprint import Imprint
+
+imprint = Imprint(
+    agent_id="reviewer",
+    agent_description="A code reviewer that suggests improvements to pull requests.",
+    model="anthropic:claude-haiku-4-5-20251001",   # reads ANTHROPIC_API_KEY from env
+    store="sqlite:///~/.imprint/reviewer.db",
+    processing_mode="balanced",                    # frugal | balanced | eager
+    scopes=["project:alpha", "role:reviewer"],     # optional: declared scope set
+)
+await imprint.connect()
+
+# After each user turn, hand imprint the agent's last output and the user's reply.
+# Most replies carry no signal and nothing is stored.
+await imprint.observe(
+    user_id="rami",
+    agent_output="I suggest using bullet points here.",
+    user_response="No, write in paragraphs.",
+)
+
+# Before each agent turn, compile a behavioral policy for this user.
+# The output is a ready-to-inject text block, filtered to memories that
+# match the requested scopes and deduplicated against existing instructions.
+policy = await imprint.get_policy(
+    user_id="rami",
+    existing_instructions="You are a helpful code reviewer.",
+    scopes=["project:alpha"],
+    max_output_tokens=400,
+)
+
+print(policy.text)
+# -> "Write feedback in paragraphs rather than bullet points."
+```
+
+Models use [pydantic-ai](https://ai.pydantic.dev) under the hood. Any provider
+string pydantic-ai supports works: `"openai:gpt-4o"`, `"google:gemini-2.5-pro"`,
+`"ollama:llama3"`, etc. For more control pass a `pydantic_ai.models.Model`
+instance directly.
+
+## How it works
+
+`observe()` runs four stages in order:
+
+1. **Detection** decides whether the user's response carries a signal worth
+   capturing. Pattern heuristics fire first; an LLM call runs as fallback in
+   balanced mode or always in eager mode. Most observations stop here at zero
+   LLM cost.
+2. **Derivation** converts the signal into a canonical typed memory: what type
+   (FACT, RULE, DECISION, CONTEXT), what content, what scope.
+3. **Persistence** writes the memory and its supporting signal to SQLite and
+   keeps the full-text search index in sync.
+4. **Consolidation** compares the new memory against existing ones and decides
+   for each: merge (redundant), contradict (now wrong), or distinct (keep both).
+   Memories marked merged or contradicted are deactivated.
+
+`get_policy()` lists the active memories that match the requested scopes, hashes
+the inputs into a cache key, and returns a cached compile if one is available.
+Otherwise it asks the LLM to compile a behavioral policy and caches the result.
+The cache invalidates whenever a new memory is written for that user.
+
+When a vector store and embedder are configured, `get_policy()` switches to
+hybrid retrieval: BM25 sparse search over the full-text index fused with dense
+vector search via Reciprocal Rank Fusion. A `BanditAlphaTuner` learns the
+optimal sparse/dense balance per agent from implicit feedback.
+
+## Processing modes
+
+- **frugal** - pattern heuristics only; zero LLM cost for observation. Misses
+  subtle signals. Good for high-volume or cost-sensitive deployments.
+- **balanced** *(default)* - heuristics first, LLM fallback when silent. One
+  LLM call per ambiguous observation.
+- **eager** - always uses the LLM for detection, derivation, and validation.
+  Best signal recall, highest cost. Adds a pre-validation pass for
+  `observe_directions()` and LLM-based correction attribution in the feedback loop.
+
+## Scopes
+
+Scopes let one Imprint instance hold context-specific memories without cross-
+contamination. Declare the candidate set on construction:
+
+```python
+imprint = Imprint(
+    agent_id="reviewer",
+    scopes=["project:alpha", "project:beta", "role:reviewer"],
+)
+```
+
+A memory is tagged with one scope at write time. The LLM picks from the declared
+set during derivation, or the caller passes `scope=` to `observe()` explicitly.
+Unknown scopes fall back to `"global"`. The `"global"` scope is always available
+and matches every retrieval call.
+
+`get_policy(scopes=...)` filters which memories are visible. A memory matches
+when its scope is `"global"` or appears in the requested list. Omitting `scopes`
+returns all memories for that user.
+
+## Injecting directives directly
+
+`observe_directions()` persists explicit instructions without the detect stage.
+Useful for onboarding flows, settings screens, or any surface where the user
+explicitly configures how the agent should behave.
+
+```python
+memories = await imprint.observe_directions(
+    user_id="rami",
+    directions=[
+        "Always respond in English.",
+        "Never use bullet points.",
+        "Keep responses under 200 words.",
+    ],
+    source=MemorySource.USER_EDIT,
+)
+```
+
+In eager mode a batched LLM validation pre-pass filters out hedges and
+non-directives before any memory is written.
+
+## Feedback loop
+
+Imprint tracks an open feedback loop per user session. The loop opens when
+`get_policy()` is called and closes on the next `observe()` or an explicit
+`observe_feedback()` call.
+
+```python
+# Explicit quality signal from the application layer.
+# outcome: -1.0 = clear failure, 0.0 = neutral, 1.0 = clear success.
+await imprint.observe_feedback(user_id="rami", outcome=0.9)
+```
+
+Implicit signals are also extracted automatically: a CORRECTION closes the loop
+with a negative reward, a REINFORCEMENT with a positive one. When an embedder is
+configured, corrections trigger an embedding-based attribution pass that
+identifies which ranked memory was most relevant to the correction and adjusts
+the retrieval alpha accordingly. In eager mode an LLM call makes this attribution
+more precise.
+
+Loops expire lazily after `feedback_timeout` seconds (default: 1 hour).
+
+## Extras
+
+### Vector retrieval (`imprint[vector]`)
+
+```python
+from imprint import Imprint, SQLiteVecStore
+from imprint.voyage import VoyageEmbedder
+
+imprint = Imprint(
+    agent_id="assistant",
+    vector_store=SQLiteVecStore("assistant.db"),
+    embedder=VoyageEmbedder(),                 # reads VOYAGE_API_KEY from env
+)
+```
+
+When a vector store and embedder are provided, `observe()` embeds each new
+memory alongside it. `get_policy()` switches to hybrid BM25 + dense retrieval
+when a `context` string is provided.
+
+### Online decay (`imprint[online]`)
+
+```python
+from imprint import Imprint, FSRSGradientDecay
+
+imprint = Imprint(
+    agent_id="assistant",
+    decay_model=FSRSGradientDecay(),
+)
+```
+
+`FSRSGradientDecay` replaces the default static decay formula with a River
+online regression model that learns per-agent decay parameters from feedback
+events. State is persisted to the agent database and survives restarts.
+
+## Layout
+
+```
+src/imprint/
+  _core.py               # Imprint facade, Policy, open loop tracking
+  store.py               # SQLiteMemoryStore, event logging, FTS5 index
+  types.py               # Memory, Signal, MemoryType, SignalType, enums
+  protocols.py           # adapter protocols (10 interfaces)
+  retrieval.py           # StaticAlphaTuner, BanditAlphaTuner, RRF fusion
+  decay.py               # FSRSStaticDecay
+  online.py              # FSRSGradientDecay (requires imprint[online])
+  detect.py              # heuristic signal detection
+  budget.py              # HeuristicTokenCounter
+  tokens.py              # AnthropicAPITokenCounter
+  vector.py              # SQLiteVecStore (requires imprint[vector])
+  voyage.py              # VoyageEmbedder, VoyageTokenCounter (requires imprint[voyage])
+  prompts/               # one module per LLM-call prompt
+tests/
+  test_imprint.py        # unit tests + live-marked integration tests
+  test_store.py          # SQLite store tests
+  test_detect.py         # heuristic detection tests
+  test_types.py          # type model tests
+  test_ascii_audit.py    # encoding guard
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and [just](https://github.com/casey/just).
+
+```sh
+just sync         # install all extras into .venv
+just check        # lint, format-check, typecheck, test
+just fmt          # auto-format
+just test-live    # run live tests (require ANTHROPIC_API_KEY)
+just clean        # remove caches and local SQLite databases
+```
+
+Live tests are excluded from the default run. They hit the real Anthropic API
+and need a key. Copy `.env.example` to `.env` and fill in the values.
+
+## API stability
+
+The public API is shaped but not stable. Breaking changes between 0.x versions
+should be expected. The core observe/get_policy contract is the most stable
+part; adapter protocols and optional extra APIs may shift.
+
+## License
+
+[Apache 2.0](LICENSE).