41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# HopeMesh 2.0
|
|
|
|
HopeMesh 2.0 is a Python package for federated humanitarian allocation workflows in disrupted networks.
|
|
|
|
It provides:
|
|
- Canonical primitives for `LocalProblem`, `SharedVariables`, `PlanDelta`, `Policy`, `AttestationHint`, `AuditLog`, and `PrivacyBudget`.
|
|
- A Graph-of-Contracts registry for versioned schemas and adapters.
|
|
- A tamper-evident governance ledger.
|
|
- Small SDK helpers for deterministic construction and delta merging.
|
|
- A CLI for local registry and ledger snapshots.
|
|
|
|
## Layout
|
|
|
|
- `hopemesh/core.py`: primitive dataclasses and fingerprinting helpers.
|
|
- `hopemesh/contracts.py`: Graph-of-Contracts and governance ledger.
|
|
- `hopemesh/sdk.py`: DSL-style constructors and merge helpers.
|
|
- `hopemesh/cli.py`: local CLI for registry and ledger operations.
|
|
- `tests/`: unit tests for primitives, registry, ledger, and helpers.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
python3 -m pip install --upgrade build
|
|
python3 -m build
|
|
./test.sh
|
|
```
|
|
|
|
## CLI
|
|
|
|
```bash
|
|
python -m hopemesh.cli --version
|
|
python -m hopemesh.cli registry init --store .hopemesh/state.json
|
|
python -m hopemesh.cli registry add-schema --name allocation --schema-version 1.0 --definition-json '{"fields":["region","qty"]}'
|
|
python -m hopemesh.cli ledger verify
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The project is intentionally dependency-light and uses the Python standard library for validation, hashing, and snapshotting.
|
|
- `test.sh` runs `python3 -m build`, a smoke import/instantiate check, and the unit test suite.
|