provalume 0.1.0__tar.gz

provalume-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Provalume project-local state (never committed; see docs/security/PRIVACY_MODEL.md)
+.provalume/
+
+# Eval outputs are reproducible artifacts, not source. The committed
+# baselines live in evals/results/baseline/ and are tracked explicitly.
+evals/results/*
+!evals/results/baseline/
+!evals/results/.gitkeep
+
+# Generated agent context files. Provalume must never let these enter a
+# commit; .gitignore is defence in depth, not the mechanism. See
+# src/provalume/integrations/generic.py::materialize / cleanup.
+/AGENTS.md
+/CLAUDE.md
+/GEMINI.md
+/.provalume-digest.md
+
+# OS / editor
+.DS_Store
+*.swp
+.idea/
+.vscode/

provalume-0.1.0/CHANGELOG.md

@@ -0,0 +1,111 @@
+# Changelog
+
+Format based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versioning: [semantic versioning](https://semver.org/spec/v2.0.0.html), with the
+pre-1.0 caveat that `0.x` minor bumps may break the SDK.
+
+## [0.1.0] — 2026-07-25
+
+First release. Verified, git-aware memory for autonomous software agents.
+
+### Added
+
+**Immutable event journal.** Append-only, enforced by SQLite triggers rather than
+by convention. Canonical JSON serialisation, deterministic SHA-256 hashing, a
+per-database hash chain, idempotent ingestion, and full projection rebuild. WAL,
+linear forward-only migrations, and refusal to open a schema newer than the code
+understands.
+
+**Six memory categories** — episodic, semantic, procedural, decision, gotcha,
+performance — each with its own promotion ceiling, recency half-life, and write
+trigger.
+
+**Eight trust states** in two shapes: a five-rung ladder (`quarantined` →
+`observed` → `verified` → `reviewed` → `integrated`) and three terminal states
+(`invalidated`, `superseded`, `rejected`). Rungs cannot be skipped, agents cannot
+promote, self-review never promotes, and rejection is permanent. Every transition
+records the named policy rule and the evidence it relied on — **including
+refusals**.
+
+**Deterministic writers.** No language model anywhere in the canonical path.
+Verification failures become gotchas keyed on normalised failure signatures;
+repeats fold into one record with an occurrence count; a later success attaches as
+the resolution; review rejections become lessons; human decisions become decision
+memory; passing commands become procedural candidates.
+
+**Branch- and commit-aware truth.** Read-only Git access for ancestry and commit
+existence. A query as of commit X does not present a fact introduced after X as
+current truth, and where ancestry cannot be established — after a rebase or a
+cherry-pick — applicability is labelled `uncertain` rather than guessed.
+
+**Bi-temporal validity.** `valid_at` / `invalid_at` / `recorded_at`, with
+invalidation and supersession instead of overwriting. Contradictions are detected
+and surfaced, never auto-resolved.
+
+**Explainable retrieval.** FTS5 and BM25 with a documented nine-component scoring
+policy, every constant published in `docs/reference/RETRIEVAL.md`. Filters
+authorise; scoring only reorders. Every result reports which filters it passed,
+each score component and its contribution, human-readable reasons, and warnings.
+Ordering is fully deterministic.
+
+**Budgeted digests.** Hard character or estimated-token ceiling enforced by
+construction, banner-first, per-item trust labels and provenance, near-duplicate
+suppression, and a reported count of what did not fit.
+
+**Pre-action warning gate.** Deterministic failure signatures with five match
+tiers. Warns by default and never blocks unless an explicit policy, an exact
+signature match, and repetition all coincide. Warning outcomes are recordable, so
+usefulness is measurable rather than assumed.
+
+**Memory-poisoning resistance** as an architectural property: deterministic
+evidence as the only promotion path, structural `source`, scope containment,
+terminal rejection, and an untrusted-data banner — backed by heuristics and
+containment, in that order of importance.
+
+**Redaction before every durable write**, with hashing afterwards so stored
+hashes cover what is actually on disk. `provalume audit` re-scans stored content.
+
+**JSONL interchange.** Byte-identical exports, merge-friendly ordering, and an
+import path that recomputes hashes rather than trusting them, rejects future
+record versions, refuses foreign projects by default, and surfaces divergent
+supersession as a conflict. Optional HMAC-SHA256 and Ed25519 signatures, both
+fail-closed.
+
+**Stable Python SDK, full CLI, and an MCP server** implemented against protocol
+revision `2025-11-25` using only the standard library. The MCP surface exposes
+read tools plus `propose`; promotion, invalidation, supersession, and delete are
+absent by design and pinned by a test.
+
+**Offline demo** (`provalume demo`) running the real engine in under a minute,
+with an optional light-themed HTML report.
+
+**Twenty-scenario replayable eval harness** with committed baseline results.
+
+**Optional experimental vector retrieval** with a stdlib `HashingEmbedder`
+baseline so the vector path is CI-tested without any optional dependency, plus
+model2vec and fastembed backends and reciprocal rank fusion. Vectors never
+authorise a record.
+
+**Orkestra adapter** with structured event ingestion, digest injection, and
+deterministic cleanup of generated context files.
+
+**Documentation**: 18 ADRs, a 26-threat threat model, trust model, poisoning
+analysis, privacy model, data model, retrieval reference, preflight reference,
+JSONL specification, MCP guide, benchmark methodology, and a limitations document
+that leads with the largest known weakness.
+
+### Known limitations
+
+Not dogfooded on production runs — the schema comes from literature, a competitor
+review, and a synthetic eval harness rather than from mined production failure
+frequencies. No hard deletion, no access control, no cross-project memory, no
+verified vendor context-file pickup. Retrieved memory cannot be forced to stay
+data. Full list: `docs/reference/LIMITATIONS.md`.
+
+### Not claimed
+
+No benchmark comparison against any other system. No LongMemEval-V2 score. No
+superiority claim of any kind. `docs/reference/BENCHMARKS.md` explains what is
+measured and what is not.
+
+[0.1.0]: https://github.com/andyyaro/provalume/releases/tag/v0.1.0

provalume-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 choose to offer,
+      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 [yyyy] [name of copyright owner]
+
+   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.

provalume-0.1.0/NOTICE

@@ -0,0 +1,70 @@
+Provalume
+Copyright 2026 Andy Yaro
+
+This product includes software developed by Andy Yaro.
+
+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.
+
+-------------------------------------------------------------------------------
+Third-party notices
+-------------------------------------------------------------------------------
+
+Provalume contains no third-party source code. Its required runtime
+dependencies are used as libraries under their own licenses:
+
+  pydantic     MIT          https://github.com/pydantic/pydantic
+  typer        MIT          https://github.com/fastapi/typer
+  rich         MIT          https://github.com/Textualize/rich
+
+Optional extras, installed only when explicitly requested:
+
+  cryptography Apache-2.0 OR BSD-3-Clause  https://github.com/pyca/cryptography
+  numpy        BSD-3-Clause                https://github.com/numpy/numpy
+  model2vec    MIT                         https://github.com/MinishLab/model2vec
+  fastembed    Apache-2.0                  https://github.com/qdrant/fastembed
+
+-------------------------------------------------------------------------------
+Attribution of ideas (no code copied)
+-------------------------------------------------------------------------------
+
+Provalume's design was informed by reading the following projects and papers.
+No source code from any of them was copied, adapted, or vendored. See
+docs/research/COMPETITOR_TRIALS.md for the review that produced these notes and
+docs/adr/ for the decisions taken.
+
+  Bi-temporal facts with invalidation instead of deletion
+    Zep / Graphiti (Apache-2.0, https://github.com/getzep/graphiti) and
+    "Zep: A Temporal Knowledge Graph Architecture for Agent Memory"
+    (arXiv:2501.13956). Schema concept only.
+
+  Pre-action gate that warns before repeating a known-failed fix
+    ProjectMem (MIT, https://github.com/riponcm/projectmem),
+    arXiv:2606.12329. Concept only; Provalume's gate is an independent
+    implementation keyed on deterministic failure signatures.
+
+  Verify-before-promote for procedural memory
+    Voyager (arXiv:2305.16291) and Memp (arXiv:2508.06433).
+
+  Recency x usage x relevance scoring with usage-weighted decay
+    Generative Agents (arXiv:2304.03442) and MemoryBank (arXiv:2305.10250).
+
+  Reciprocal rank fusion over lexical and vector retrieval; single-file
+  SQLite substrate with FTS5 plus optional vectors
+    AIngram (Apache-2.0, https://github.com/bozbuilds/AIngram) as a published
+    reference architecture; RRF itself is from Cormack et al., 2009.
+
+  Memory governance as first-class metadata
+    MemOS (arXiv:2507.03724). Framing only.
+
+  Git-committed JSONL as the portable interchange layer with a database as
+  a rebuildable cache
+    Beads (MIT, https://github.com/steveyegge/beads).