remaind 0.1.0__tar.gz

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

@@ -0,0 +1,97 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - run: ruff check src tests
+
+  typecheck:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - run: mypy
+
+  pytest:
+    name: pytest (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install package + dev extras
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run pytest
+        run: python -m pytest -q
+
+  build:
+    name: wheel + sdist build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist + wheel
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --sdist --wheel
+          ls -la dist/
+
+      - name: Smoke-install the built wheel
+        run: |
+          python -m venv /tmp/install-check
+          /tmp/install-check/bin/pip install dist/*.whl
+          /tmp/install-check/bin/remaind --version
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7

remaind-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,63 @@
+name: release
+
+# Manual-dispatch only for now. Before the first run, create the project on
+# PyPI and configure a Trusted Publisher pointing at:
+#   owner/repo:  magpiexyz-lab/Remaind
+#   workflow:    release.yml
+#   environment: pypi
+# Once that's done, run this workflow from the Actions tab with the tag to
+# publish. A future change can add `release: { types: [published] }` to the
+# trigger so tagged releases publish automatically.
+
+on:
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "Git tag to build and publish (e.g. v0.1.0)"
+        required: true
+        default: "v0.1.0"
+
+jobs:
+  build:
+    name: build sdist + wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --sdist --wheel
+
+      - name: Verify the wheel installs and runs
+        run: |
+          python -m venv /tmp/release-check
+          /tmp/release-check/bin/pip install dist/*.whl
+          /tmp/release-check/bin/remaind --version
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for PyPI Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

remaind-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.coverage
+.coverage.*
+htmlcov/
+
+# Remaind runtime state (created by `remaind init`; do not commit)
+.context/active/resume_packet.md
+.context/active/history/
+.context/db/
+.context/artifacts/
+
+# Environment + secrets
+.env
+.env.local
+.env.*.local
+*.key
+*.pem
+credentials*
+*.secret
+*.token
+service-account*.json
+
+# OS / IDE
+.DS_Store
+Thumbs.db
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Debug logs
+*.log

remaind-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Experiment Template Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

remaind-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: remaind
+Version: 0.1.0
+Summary: Durable context for long-running agents.
+Project-URL: Homepage, https://github.com/magpiexyz-lab/Remaind
+Project-URL: Repository, https://github.com/magpiexyz-lab/Remaind
+Author: Magpie Labs
+License: MIT
+License-File: LICENSE
+Keywords: agents,compaction,context,handover,ledger
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.18
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-jsonschema>=4.18; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Remaind
+
+[![tests](https://github.com/magpiexyz-lab/Remaind/actions/workflows/ci.yml/badge.svg)](https://github.com/magpiexyz-lab/Remaind/actions/workflows/ci.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-blue)](#)
+[![license](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Durable context for long-running agents.**
+
+Remaind is a local-first context ledger, compaction pipeline, and resume
+substrate for AI agents. It preserves the meaningful state of an agent run
+across context resets: a future agent can start with a clean model context,
+load Remaind's local state, understand what happened before, know what must
+happen next, and continue safely without asking the user to reconstruct the
+work.
+
+Remaind is not a wiki — it is a **machine-readable and human-readable
+continuity layer**: raw event ledger, structured state, compact handover,
+searchable memory, structured validation, safe rollback, and a mechanical
+resume gate.
+
+## Install
+
+```sh
+git clone https://github.com/magpiexyz-lab/Remaind.git
+cd Remaind
+python3 -m venv .venv
+.venv/bin/pip install -e ".[dev]"
+```
+
+Requires Python ≥ 3.11.
+
+## Quick start
+
+```sh
+# Bootstrap a .context/ in the current directory.
+remaind init
+
+# Inspect what's there.
+remaind validate
+remaind status
+
+# After work happens (events appended by your agent harness),
+# compact when token band climbs.
+remaind compact
+
+# Build a resume packet for a fresh agent run.
+remaind resume --next-tool deploy_prod
+
+# Roll back if something went wrong.
+remaind rollback --to 2026-05-14T03:54:33Z
+```
+
+## What lives in `.context/`
+
+```
+.context/
+├── README.md
+├── CONTRACT.md           # the contract — read this first
+├── active/
+│   ├── state.json        # derived working state (atomic replace)
+│   ├── handover.md       # compact continuity document (atomic replace)
+│   └── (resume_packet.md, history/  — runtime, git-ignored)
+├── logs/
+│   └── events.jsonl      # append-only raw timeline (source of truth)
+├── schemas/
+│   ├── event.schema.json         # JSON Schema Draft 2020-12
+│   ├── state.schema.json
+│   ├── memory.schema.json
+│   ├── validation.schema.json
+│   ├── thresholds.yaml           # 40k/60k/70k/80k band math
+│   ├── redaction.yaml            # 9 default secret patterns
+│   ├── tools.yaml                # mechanical risk flags
+│   └── migrations/{state,events}/
+└── (db/context.sqlite, artifacts/  — runtime, git-ignored)
+```
+
+## Authority order
+
+When sources disagree, lower wins:
+
+1. Latest explicit user instruction
+2. Raw event log (`logs/events.jsonl`)
+3. `active/state.json`
+4. `active/handover.md`
+5. Derived memories
+
+A stale summary or memory MUST NOT override a newer user instruction.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `remaind init` | Bootstrap `.context/`; `--force` backs up existing |
+| `remaind validate` | Walk the v1 checklist (structure, schemas, events, SQLite) |
+| `remaind status [--json]` | State + thresholds + event counts + compaction recommendation |
+| `remaind compact` | Run the compaction pipeline, gated by structured validation |
+| `remaind resume [--next-tool TOOL]` | Build a resume packet; consult the resume gate |
+| `remaind rollback --to <ts>` | Restore derived files from history; raw log untouched |
+
+## Architecture
+
+| Phase | Subject |
+|---|---|
+| 1 | Frozen contract — schemas, configs, layout |
+| 2 | Migration interfaces — state migrations + event adapters (Protocols) |
+| 3 | `init` + `validate` + schema/config loaders + JSONL streaming |
+| 4 | Redaction engine + content-addressed artifact store + append-only event writer |
+| 5 | Atomic state/handover writes + history snapshots + threshold band recompute |
+| 6 | `status` human/JSON inspector |
+| 7 | SQLite memory + FTS5 (memories, memories_fts, events_index) |
+| 8 | `chars/4` token estimator + compaction-needed surface |
+| 9 | Source-event selection + reference compactor |
+| 10 | Structured compaction validator (reject-on-any-false) |
+| 11 | Resume packet builder + mechanical resume gate |
+| 12 | Rollback (restores derived files; raw log untouched) |
+
+## V1 non-goals
+
+No vector search, no multi-writer semantics, no cross-project global user
+memory, no procedural memory, no remote sync, no hosted UI, no
+provider-managed conversation state as a dependency, no destructive raw-log
+migration.
+
+## Hard rules
+
+- Do not rewrite `events.jsonl`.
+- Do not let summaries become source of truth.
+- Do not store secrets in raw logs.
+- Do not store huge outputs inline (threshold: 4096 bytes).
+- Do not allow stale memory to override latest user instruction.
+- Do not accept compaction without structured validation.
+- Do not mutate files on resume if the resume packet is contradictory or unsafe.
+
+## Tests
+
+```sh
+.venv/bin/python -m pytest -q
+```
+
+177 tests covering every phase. Adding a feature? Add a test.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

remaind-0.1.0/README.md

@@ -0,0 +1,144 @@
+# Remaind
+
+[![tests](https://github.com/magpiexyz-lab/Remaind/actions/workflows/ci.yml/badge.svg)](https://github.com/magpiexyz-lab/Remaind/actions/workflows/ci.yml)
+[![python](https://img.shields.io/badge/python-3.11%2B-blue)](#)
+[![license](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Durable context for long-running agents.**
+
+Remaind is a local-first context ledger, compaction pipeline, and resume
+substrate for AI agents. It preserves the meaningful state of an agent run
+across context resets: a future agent can start with a clean model context,
+load Remaind's local state, understand what happened before, know what must
+happen next, and continue safely without asking the user to reconstruct the
+work.
+
+Remaind is not a wiki — it is a **machine-readable and human-readable
+continuity layer**: raw event ledger, structured state, compact handover,
+searchable memory, structured validation, safe rollback, and a mechanical
+resume gate.
+
+## Install
+
+```sh
+git clone https://github.com/magpiexyz-lab/Remaind.git
+cd Remaind
+python3 -m venv .venv
+.venv/bin/pip install -e ".[dev]"
+```
+
+Requires Python ≥ 3.11.
+
+## Quick start
+
+```sh
+# Bootstrap a .context/ in the current directory.
+remaind init
+
+# Inspect what's there.
+remaind validate
+remaind status
+
+# After work happens (events appended by your agent harness),
+# compact when token band climbs.
+remaind compact
+
+# Build a resume packet for a fresh agent run.
+remaind resume --next-tool deploy_prod
+
+# Roll back if something went wrong.
+remaind rollback --to 2026-05-14T03:54:33Z
+```
+
+## What lives in `.context/`
+
+```
+.context/
+├── README.md
+├── CONTRACT.md           # the contract — read this first
+├── active/
+│   ├── state.json        # derived working state (atomic replace)
+│   ├── handover.md       # compact continuity document (atomic replace)
+│   └── (resume_packet.md, history/  — runtime, git-ignored)
+├── logs/
+│   └── events.jsonl      # append-only raw timeline (source of truth)
+├── schemas/
+│   ├── event.schema.json         # JSON Schema Draft 2020-12
+│   ├── state.schema.json
+│   ├── memory.schema.json
+│   ├── validation.schema.json
+│   ├── thresholds.yaml           # 40k/60k/70k/80k band math
+│   ├── redaction.yaml            # 9 default secret patterns
+│   ├── tools.yaml                # mechanical risk flags
+│   └── migrations/{state,events}/
+└── (db/context.sqlite, artifacts/  — runtime, git-ignored)
+```
+
+## Authority order
+
+When sources disagree, lower wins:
+
+1. Latest explicit user instruction
+2. Raw event log (`logs/events.jsonl`)
+3. `active/state.json`
+4. `active/handover.md`
+5. Derived memories
+
+A stale summary or memory MUST NOT override a newer user instruction.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `remaind init` | Bootstrap `.context/`; `--force` backs up existing |
+| `remaind validate` | Walk the v1 checklist (structure, schemas, events, SQLite) |
+| `remaind status [--json]` | State + thresholds + event counts + compaction recommendation |
+| `remaind compact` | Run the compaction pipeline, gated by structured validation |
+| `remaind resume [--next-tool TOOL]` | Build a resume packet; consult the resume gate |
+| `remaind rollback --to <ts>` | Restore derived files from history; raw log untouched |
+
+## Architecture
+
+| Phase | Subject |
+|---|---|
+| 1 | Frozen contract — schemas, configs, layout |
+| 2 | Migration interfaces — state migrations + event adapters (Protocols) |
+| 3 | `init` + `validate` + schema/config loaders + JSONL streaming |
+| 4 | Redaction engine + content-addressed artifact store + append-only event writer |
+| 5 | Atomic state/handover writes + history snapshots + threshold band recompute |
+| 6 | `status` human/JSON inspector |
+| 7 | SQLite memory + FTS5 (memories, memories_fts, events_index) |
+| 8 | `chars/4` token estimator + compaction-needed surface |
+| 9 | Source-event selection + reference compactor |
+| 10 | Structured compaction validator (reject-on-any-false) |
+| 11 | Resume packet builder + mechanical resume gate |
+| 12 | Rollback (restores derived files; raw log untouched) |
+
+## V1 non-goals
+
+No vector search, no multi-writer semantics, no cross-project global user
+memory, no procedural memory, no remote sync, no hosted UI, no
+provider-managed conversation state as a dependency, no destructive raw-log
+migration.
+
+## Hard rules
+
+- Do not rewrite `events.jsonl`.
+- Do not let summaries become source of truth.
+- Do not store secrets in raw logs.
+- Do not store huge outputs inline (threshold: 4096 bytes).
+- Do not allow stale memory to override latest user instruction.
+- Do not accept compaction without structured validation.
+- Do not mutate files on resume if the resume packet is contradictory or unsafe.
+
+## Tests
+
+```sh
+.venv/bin/python -m pytest -q
+```
+
+177 tests covering every phase. Adding a feature? Add a test.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

remaind-0.1.0/pyproject.toml

@@ -0,0 +1,98 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "remaind"
+version = "0.1.0"
+description = "Durable context for long-running agents."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [{ name = "Magpie Labs" }]
+keywords = ["agents", "context", "ledger", "compaction", "handover"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "jsonschema>=4.18",
+    "pyyaml>=6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.6",
+    "mypy>=1.10",
+    "types-jsonschema>=4.18",
+    "types-PyYAML>=6.0",
+]
+
+[project.scripts]
+remaind = "remaind.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/magpiexyz-lab/Remaind"
+Repository = "https://github.com/magpiexyz-lab/Remaind"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/remaind"]
+# `_templates/` ships automatically as part of the `remaind` package — no
+# force-include needed. Non-Python resources are picked up because hatch
+# walks the whole package directory.
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+addopts = "-ra --strict-markers"
+pythonpath = ["src"]
+
+[tool.coverage.run]
+branch = true
+source = ["src/remaind"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["template-archive"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+    "RUF", # ruff-specific
+]
+ignore = [
+    "E501",   # line length handled by formatter
+    "RUF002", # ambiguous unicode in docstrings (× and — used intentionally)
+]
+
+[tool.mypy]
+python_version = "3.11"
+files = ["src/remaind"]
+exclude = "template-archive"
+check_untyped_defs = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+no_implicit_optional = true
+warn_return_any = false  # too noisy with JSON-shaped dicts
+strict_equality = true

remaind-0.1.0/src/remaind/__init__.py

@@ -0,0 +1,3 @@
+"""Remaind — durable context for long-running agents."""
+
+__version__ = "0.1.0"

remaind-0.1.0/src/remaind/__main__.py

@@ -0,0 +1,10 @@
+"""Allow `python -m remaind ...` to invoke the CLI."""
+
+from __future__ import annotations
+
+import sys
+
+from .cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())