Metadata-Version: 2.4
Name: modekeeper
Version: 0.1.31
Summary: ModeKeeper: verify-first, customer-safe read-only agent; apply is licensed and gated
Author: ModeKeeper
License-Expression: LicenseRef-Proprietary
Keywords: mlops,observability,autotuning,safety
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cryptography>=42.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4; extra == "dev"
Requires-Dist: ruff>=0.4.8; extra == "dev"
Dynamic: license-file

# ModeKeeper

[![CI](https://github.com/abcexpert/modekeeper/actions/workflows/ci.yml/badge.svg)](https://github.com/abcexpert/modekeeper/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/modekeeper.svg)](https://pypi.org/project/modekeeper/)

ModeKeeper is a verify-first operations agent for SRE, MLOps, and FinOps teams. The public runtime is customer-safe and read-only by default; apply is licensed and hard-gated.

## Start here (10 minutes)

Use the buyer script [`docs/BUYER_10MIN.md`](docs/BUYER_10MIN.md) and proof-pack map [`docs/PROOF_PACKS.md`](docs/PROOF_PACKS.md). Canonical path: procurement pack.

```bash
./bin/mk-procurement-pack
```

```bash
cd report/procurement_pack && sha256sum -c checksums.sha256
```

Verify-first means every deliverable is deterministic, accompanied by SHA256 manifests, and backed by reproducible transcripts.
Validation should start from hashes and transcript evidence before any business review.

PRO note: private releases are notes-only.
Deliverables are distributed via vendor-provided stamp + transcripts + SHA256.

<!-- MK_RELEASE_CHANNELS_START -->
## Release channels and versioning

- **Public (OSS / read-only):** this repository + PyPI package `modekeeper` (wheel-only). GitHub Releases here track the public package.
- **Enterprise PRO (licensed / gated apply):** delivered separately as **notes-only** release metadata + vault-only deliverables (no GitHub assets attached).
- **Why numbers can differ:** public and PRO ship independently; the canonical PRO deliverable is always recorded in:
  - `docs/PROJECT_FINAL.md` (entrypoint)
  - `docs/STATUS.md` / `docs/SNAPSHOT.md` (latest release + vault + SHA256)

<!-- MK_RELEASE_CHANNELS_END -->


## Contact
Documentation index: [`docs/INDEX.md`](docs/INDEX.md)


- Questions / feedback: GitHub Issues (preferred) and Discussions.
- Security issues: please use GitHub Security Advisories (private disclosure). See `.github/SECURITY.md`.

## Start here

- Buyer journey: [`docs/BUYER_JOURNEY.md`](docs/BUYER_JOURNEY.md)
- Product overview: [`docs/product.md`](docs/product.md)
- Quickstart: [`docs/QUICKSTART.md`](docs/QUICKSTART.md)
- Security posture: [`docs/SECURITY_POSTURE.md`](docs/SECURITY_POSTURE.md)
- Buyer proof pack: [`docs/BUYER_PROOF_PACK.md`](docs/BUYER_PROOF_PACK.md)
- Procurement pack: [`docs/PROCUREMENT_PACK.md`](docs/PROCUREMENT_PACK.md)
- Proof packs overview: [`docs/PROOF_PACKS.md`](docs/PROOF_PACKS.md)
- 10-minute buyer script: [`docs/BUYER_10MIN.md`](docs/BUYER_10MIN.md)
- Enterprise evaluation: [`docs/ENTERPRISE_EVALUATION.md`](docs/ENTERPRISE_EVALUATION.md)
- Current project status: [`docs/STATUS.md`](docs/STATUS.md)
- Workflow details: [`docs/WORKFLOW.md`](docs/WORKFLOW.md)
- Distribution boundary policy: [`docs/DISTRIBUTION_POLICY.md`](docs/DISTRIBUTION_POLICY.md)

## 60-second quickstart

```bash
python3 -m pip install -U modekeeper
mk --help
mk observe --source synthetic --duration 10s --out report/quickstart/observe
mk closed-loop run --scenario drift --observe-source synthetic --observe-duration 10s --dry-run --out report/quickstart/plan
mk export bundle --in report/quickstart --out report/quickstart/export

# quickstart artifacts
ls report/quickstart
ls report/quickstart/observe
ls report/quickstart/plan
ls report/quickstart/export
```

Expected artifact roots:
- `report/quickstart/observe` (read-only telemetry capture)
- `report/quickstart/plan` (dry-run planning outputs)
- `report/quickstart/export` (bundle/export outputs)

## Safety gates

Apply/mutate paths are blocked unless all required gates pass:
- `verify_ok=true` from verify artifacts
- kill-switch is absolute (`MODEKEEPER_KILL_SWITCH=1` blocks apply)
- valid license and apply entitlement

Details and command contracts:
- [`docs/QUICKSTART.md`](docs/QUICKSTART.md)
- [`docs/WORKFLOW.md`](docs/WORKFLOW.md)

## Public vs Pro

Public GitHub + PyPI (`modekeeper`) is the showroom/stub surface with verify-first workflows (`observe -> plan -> verify -> ROI -> export`). Apply/mutate capabilities are disabled by default in public and reserved for licensed distribution; see boundary and release rules in [`docs/DISTRIBUTION_POLICY.md`](docs/DISTRIBUTION_POLICY.md).
