# STARTHERE — mgf-vm-sdk

> **Sibling library in the Magogi Foundation federation.**
> See [README.md](README.md) for what this library does; see
> [docs/inprogress/MGF_STANDARDS_CONFORMANCE.md](docs/inprogress/MGF_STANDARDS_CONFORMANCE.md)
> for the per-rule conformance ledger; see
> [mgf-common/FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md)
> for the federation contract.

`mgf-vm-sdk` is the client SDK for the Magogi Foundation distributed
vm-vmanager-app: one `VmManagerClient` interface, two transports —
`InProcessTransport` (vm-vmanager-app Local) and `GrpcTransport` (vm-vmanager-app
Fleet, Phase 1). The single library every client — CLI, GUI,
third-party tools — imports.

---

## For consumers (using this library)

1. **Pin** in your `pyproject.toml`:
   ```toml
   dependencies = ["mgf-vm-sdk>=X.Y,<X.$((Y+1))"]
   ```
   See [CHANGELOG.md](CHANGELOG.md) for the current minor.
2. **Install:**
   - `pip install mgf-vm-sdk` — local mode only (no gRPC deps).
   - `pip install 'mgf-vm-sdk[grpc]'` — + `GrpcTransport` for fleet
     mode (Phase 1).
3. **Read** [README.md](README.md) for the `VmManagerClient` surface
   and the one-client/two-transports construction pattern (D-A4).
4. **Bootstrap your app** with mgf-common first — see
   [mgf-common/STARTHERE.md](https://codeberg.org/magogi-admin/mgf-common/src/branch/main/STARTHERE.md).
5. **Adopt the federation contract** — file your
   `MGF_STANDARDS_CONFORMANCE.md` per
   [DOC-15](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/DOCUMENTATION.md).
6. **Run** `mgf-common catch-up` periodically to verify
   federation drift; see [FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md) §6.

---

## For contributors

See [CONTRIBUTING.md](CONTRIBUTING.md). Standards are inherited
from [mgf-common](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/).
The system-level architecture, decisions, and dev loop live in
`vm-vmanager-docs` (`~/PycharmProjects/vm-vmanager-docs/`).

---

## Quick links

| Resource | Where |
|---|---|
| Library purpose | [README.md](README.md) |
| Release notes | [CHANGELOG.md](CHANGELOG.md) |
| Dependencies + dependents | [DEPS.md](DEPS.md) |
| What we depend on / who depends on us | [DEPS.md](DEPS.md) |
| Conformance-level argument | [STANDARDS_NOTE.md](STANDARDS_NOTE.md) |
| Conformance ledger | [docs/inprogress/MGF_STANDARDS_CONFORMANCE.md](docs/inprogress/MGF_STANDARDS_CONFORMANCE.md) |
| Federation contract | [mgf-common/FEDERATION.md](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/FEDERATION.md) |
| Cross-project standards | [mgf-standard/docs/standards/](https://codeberg.org/magogi-admin/mgf-standard/src/branch/main/docs/standards/) |
| System architecture / decisions | `vm-vmanager-docs/` |
