piia-engram 2.9.0__tar.gz

piia_engram-2.9.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 Patdolitse
+
+   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.

piia_engram-2.9.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.4
+Name: piia-engram
+Version: 2.9.0
+Summary: Engram — AI 记忆印记。你的 AI 记忆，本地存储，跨工具共享。
+Author: Engram Contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Patdolitse/engram
+Project-URL: Repository, https://github.com/Patdolitse/engram
+Project-URL: Bug Tracker, https://github.com/Patdolitse/engram/issues
+Keywords: ai,memory,mcp,knowledge,personal-knowledge,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.0
+Requires-Dist: portalocker>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: tomli>=2.0; python_version < "3.11" and extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="assets/social_preview.png" alt="Engram - Local AI memory layer" width="640">
+
+# Engram
+
+### A local memory layer for AI coding tools
+
+**Stop re-explaining yourself every time you switch tools, projects, or sessions.**
+
+`Claude Code` | `Codex` | `Cursor` | `MCP compatible` | `100% local`
+
+[English](README.md) | [中文](README.zh-CN.md)
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/Python-3.10%2B-blue.svg)](https://python.org)
+[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-purple.svg)](https://modelcontextprotocol.io)
+
+</div>
+
+---
+
+> **TL;DR:** Engram is an MCP server that gives Claude Code, Codex, and Cursor a persistent identity layer — your profile, preferences, lessons learned, and key decisions stored as local JSON files. One write, every AI reads. 100% local, Apache 2.0.
+
+---
+
+AI coding tools are powerful, but they do not really know you.
+
+Every time you switch from Claude Code to Codex, open Cursor, start a new session, or move into a different project, you often have to explain the same things again:
+
+- how you prefer to communicate
+- how the AI should approach code
+- which project rules matter
+- which mistakes should not happen again
+- why earlier decisions were made
+
+Engram stores that collaboration memory as local files, then exposes it through MCP so different AI tools can read the same user context.
+
+The goal is simple: **make every compatible AI tool start from the same understanding of you.**
+
+## Why Engram?
+
+| Without Engram | With Engram |
+|---|---|
+| Every new session starts from zero | AI tools can load your identity and preferences |
+| Switching tools loses accumulated context | Claude Code, Codex, and Cursor can read the same memory |
+| Project rules live in scattered prompts | Rules and decisions are stored as local assets |
+| Past mistakes get repeated | Lessons learned can follow you across tools |
+| Memory is locked inside one product | Data stays local, editable, and portable |
+
+Engram is not another chat app, agent framework, or hosted memory service. It is a small local memory layer that sits underneath the tools you already use.
+
+Unlike session-memory tools that remember what happened in a task, Engram stores **who you are** — your identity, preferences, lessons, and decisions — so every AI tool starts from the same understanding of you as a person.
+
+## What It Stores
+
+Engram can store:
+
+- identity and communication preferences
+- coding style and quality standards
+- trust boundaries for AI tools
+- project snapshots
+- lessons learned
+- key technical or product decisions
+- domain knowledge that should be reused later
+
+All data is stored under `~/.engram/` as JSON and Markdown files. You can open, edit, back up, or migrate it yourself.
+
+## Quick Start
+
+```bash
+git clone https://github.com/Patdolitse/engram.git
+cd engram
+pip install -e .
+python demos/setup_engram.py
+```
+
+Then configure Engram as an MCP server in your AI coding tool.
+
+Example MCP config:
+
+```json
+{
+  "mcpServers": {
+    "engram": {
+      "command": "python",
+      "args": ["/path/to/engram/src/engram_core/mcp_server.py"]
+    }
+  }
+}
+```
+
+After restarting your MCP-compatible client, a new session can call `get_user_context` to understand your profile, preferences, lessons, and project context.
+
+## MCP Tools
+
+Engram exposes read, write, project, backup, and compatibility tools through MCP.
+
+Common tools include:
+
+| Tool | Purpose |
+|---|---|
+| `get_user_context` | Load the complete user context at the start of a session |
+| `get_identity_card` | Export a Markdown identity card for tools without MCP |
+| `get_profile` | Read the user profile |
+| `get_safe_profile` | Read the user profile with restricted fields filtered out |
+| `get_preferences` | Read communication and workflow preferences |
+| `get_trust_boundaries` | Read data access boundaries |
+| `get_quality_standards` | Read quality expectations |
+| `get_lessons` | Read reusable lessons learned |
+| `get_decisions` | Read key decisions and reasons |
+| `get_relevant_knowledge` | Find knowledge relevant to a project |
+| `save_project_snapshot` | Save project context for later sessions |
+| `add_lesson` | Add a lesson learned |
+| `add_decision` | Add a key decision |
+| `bulk_add_lessons` | Add multiple lessons in one call |
+| `bulk_add_decisions` | Add multiple decisions in one call |
+| `ingest_notes` | Parse free-form notes into lessons and decisions |
+| `export_engram` | Export a full backup |
+| `import_engram` | Import a backup |
+| `export_engram_to_openclaw` | Export OpenClaw-compatible files |
+| `import_engram_from_openclaw` | Import OpenClaw-compatible files |
+| `search_knowledge` | Search lessons and decisions by weighted multi-term relevance |
+| `get_health_report` | Knowledge asset health report (duplicates, capacity, warnings) |
+| `get_stale_knowledge` | Find active knowledge that has not been reviewed recently |
+| `get_knowledge_digest` | Summarize counts, recent additions, top accessed items, and domains |
+| `get_related_knowledge` | Follow links between lessons and decisions |
+| `find_similar_knowledge` | Find similar lessons and decisions by content |
+| `export_knowledge_report` | Export a readable Markdown knowledge report |
+| `link_knowledge` | Create a bidirectional link between two knowledge items |
+| `unlink_knowledge` | Remove a bidirectional knowledge link |
+| `update_lesson` | Update a lesson (summary, domain, status) |
+| `archive_lesson` | Mark a lesson as outdated |
+| `update_decision` | Update a decision |
+| `archive_decision` | Mark a decision as outdated |
+
+## Data Layout
+
+```text
+~/.engram/
+|-- schema_version.json
+|-- identity/
+|   |-- profile.json
+|   |-- preferences.json
+|   |-- quality_standards.json
+|   `-- trust_boundaries.json
+|-- knowledge/
+|   |-- lessons.json
+|   |-- decisions.json
+|   `-- domains.json
+|-- projects/
+|   `-- {project_id}.json
+|-- exports/
+`-- compat/
+    `-- openclaw/
+```
+
+## Supported Tools
+
+| Tool | Integration | Status |
+|---|---|---|
+| Claude Code | MCP over stdio | Tested |
+| Codex | MCP over stdio | Tested |
+| Cursor | MCP over stdio | Expected to work |
+| Claude Desktop | MCP over stdio | Expected to work |
+| OpenClaw | SOUL.md / MEMORY.md / USER.md import and export | Tested |
+| ChatGPT / Gemini / Kimi | Markdown identity card fallback | Usable |
+
+## Comparison
+
+| Feature | Engram | Claude Memory | Manual `CLAUDE.md` | Mem0 |
+|---|---|---|---|---|
+| Cross-tool sharing | Yes | Claude only | Tool-specific | Yes |
+| Local storage | Yes | Cloud | Local | Cloud / hosted |
+| Directly editable data | JSON / Markdown | Not visible | Yes | API-based |
+| MCP standard | Yes | Not applicable | Not applicable | Yes |
+| Portable backup | Copy files or export JSON | Limited | Copy files | API export |
+| Model-agnostic | Yes | Claude-focused | Depends on the tool | Yes |
+| Price | Free and open source | Included in subscription | Free | Free / paid tiers |
+
+## Built With
+
+Engram is a human-directed, AI-assisted open-source project.
+
+| Contributor | Role |
+|---|---|
+| [@Patdolitse](https://github.com/Patdolitse) | Creator, product direction, strategy, ownership |
+| Claude Code | Architecture, task planning, code review assistance |
+| Codex | Implementation, testing, documentation assistance |
+
+## FAQ
+
+**What is Engram?**
+Engram is a local-first MCP server that gives AI coding tools (Claude Code, Codex, Cursor) a persistent identity layer. It stores who you are, how you work, what you have learned, and the decisions you have made — as local JSON files on your machine.
+
+**How is Engram different from other AI memory tools?**
+Most AI memory tools store what happened in a session (task context, code changes). Engram stores who you are as a person — your identity, preferences, lessons, and decisions. This identity layer persists across tools, sessions, and projects. Your data is local JSON files you own and can edit directly.
+
+**Which AI tools does Engram support?**
+Engram works with any MCP-compatible AI tool: Claude Code, OpenAI Codex, Cursor, Claude Desktop, and others. For tools without MCP support (ChatGPT, Gemini, Kimi), you can export a Markdown identity card and paste it in manually.
+
+**How do I install Engram?**
+```bash
+git clone https://github.com/Patdolitse/engram.git
+cd engram && pip install -e .
+python demos/setup_engram.py
+```
+Then add the MCP config and restart your AI tool. The AI will call `get_user_context` automatically at the start of each session.
+
+**Does Engram send data to the cloud?**
+No. All data is stored in `~/.engram/` on your local machine. Engram never makes network requests. Your memory is yours.
+
+**How many MCP tools does Engram provide?**
+Engram exposes 44 MCP tools covering identity management, lessons learned, key decisions, project snapshots, bulk input, note ingestion, weighted knowledge search, similarity discovery, digesting, reporting, linking, and health checks.
+
+**Is Engram free?**
+Yes. Engram is free and open source under the Apache 2.0 license.
+
+## Limitations
+
+Engram is functional and actively used, but some things it intentionally does not do yet:
+
+| Area | Current State | Planned |
+|---|---|---|
+| **File safety** | Atomic JSON writes with a shared portalocker file lock | Broader stress testing |
+| **Access control** | `restricted_fields` filters profile fields from `get_user_context` and `get_safe_profile` | Per-caller ACL blocked by MCP caller identity |
+| **Encryption** | Plaintext JSON — treat like any local file | Optional field encryption (v3.0) |
+| **Caller identity** | MCP protocol doesn't pass tool identity | Blocked by MCP spec |
+| **Concurrent writes** | Protected by file lock + atomic replace for Engram JSON writes | Network-filesystem edge cases not guaranteed |
+
+**What this means in practice:**
+- Don't store passwords, API keys, or client PII in Engram
+- Any process with read access to `~/.engram/` can read your data
+- `restricted_fields` reduces what Engram emits in cold-start context, but it is not encryption or a true ACL
+
+This is not a warning to avoid Engram — it's an honest description of what it is: a local, plaintext memory layer for personal AI context. For personal use with non-sensitive data, it works well today.
+
+## Contributing
+
+Contributions, issues, and feedback are welcome.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Chinese readers can also use [CONTRIBUTING.zh-CN.md](CONTRIBUTING.zh-CN.md).
+
+## License
+
+[Apache 2.0](LICENSE). Engram is free software. Your memory belongs to you.