Metadata-Version: 2.4
Name: mimic-memory
Version: 0.2.0a0
Summary: Domain-neutral memory substrate for Mimic workflows and local OS adapters
Author-email: Mimic <hello@trymimic.ai>
License: BSL-1.1
Project-URL: Homepage, https://github.com/hermannsinghh/Mimic/tree/main/packages/mimic-memory
Project-URL: Repository, https://github.com/hermannsinghh/Mimic
Project-URL: Issues, https://github.com/hermannsinghh/Mimic/issues
Keywords: memory,agents,workflow,determinism,audit,os
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE-BSL
License-File: LICENSE-CHANGE-DATE
License-File: NOTICE
Requires-Dist: pydantic>=2.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Dynamic: license-file

# mimic-memory

Domain-neutral memory substrate for Mimic.

A Python-first memory layer for OS-wide and workflow-wide memory:

- composable modules callable from Temporal workflows;
- semantic, episodic, procedural, and artifact memory records;
- deterministic snapshot/export for `world_state_hash`;
- signed, replayable memory events;
- adapters for local OS sources, apps, and Mimic simulations.

Core code stays use-case neutral. Application-specific concepts (coach, wellness, plan, signal,
etc.) belong only in downstream adapters or examples.

## Python core

The package lives in `mimic_memory/` and provides:

- `MemoryRecord` for semantic, episodic, procedural, and artifact memory;
- `MemorySource` for OS, workflow, app, agent, connector, or import origins;
- `MemoryEvent` for replayable upsert/delete/snapshot logs;
- `MemorySnapshot` for sorted canonical JSON and `agent_memory_state` hashing;
- `InMemoryStore` for tests, local adapters, and workflow prototypes;
- `LocalEventLogStore` for append-only signed JSONL replay logs on local disk;
- OS adapters: `file_record`, `iter_file_records`, `clipboard_record`, `sqlite_records`,
  `calendar_event_record`, `screenshot_record`.

Run the focused package tests with:

```bash
pytest packages/mimic-memory/tests -q
```

Use `MemorySnapshot.world_state_component()` as the value for Mimic framework's
`world_state_hash(agent_memory_state=...)` input. This keeps snapshot timestamps and other
manifest-only fields out of the deterministic component hash.
