openccu-loom-types
Generated Pydantic models + enum definitions for the openccu-loom
REST + WebSocket contract. Sister-repo to the
openccu-loom daemon;
publishable as openccu-loom-types on PyPI.
What this package provides
openccu_loom_types.enums— every enum from the daemon'spkg/hmenum. Each enum is astr-typed PythonEnumwhose values match the wire strings the CCU emits. Source of truth:assets/schemas/enums.jsonin the openccu-loom repo.openccu_loom_types.rest— Pydantic models for the REST surface. Generated fromassets/openapi.yamlviadatamodel-code-generator.openccu_loom_types.ws— Pydantic models for the WebSocket envelope + push payloads. Generated from the same OpenAPI document (the WS envelope schemas live incomponents.schemasper ADR-0020).
Why this exists (asks.md C1 + C3)
Higher-level clients (openccu-loom-client, the future
homematicip_local refactor) need stable typed bindings against the
daemon. Without a published types package each consumer would
duplicate the model code and drift away from the daemon's wire
contract. This package is the single import every Python consumer
shares — version-pinned and CI-rebuilt on every openccu-loom release.
Regeneration workflow
Set OPENCCU_LOOM_REPO to a local checkout of the daemon repo
(default: ../openccu-loom):
# Step 1 — make sure the daemon repo's schema export is fresh:
make -C "$OPENCCU_LOOM_REPO" export-schemas
# Step 2 — regenerate this package's models:
make generate
The two-step split keeps the daemon repo authoritative; this package never re-parses Go source.
Tooling required
- Python >= 3.11
datamodel-code-generator>= 0.25 (for REST + WS Pydantic models)
Install both with pip install -e '.[dev]'.
Versioning & contract identity
The package version (const.VERSION) is independent of the daemon
version; the regeneration workflow bumps the patch number on every
daemon release. The daemon coupling is carried by two stamped
constants in const.py (written by make generate →
scripts/stamp_const.py):
SCHEMA_DIGEST— canonical digest of the daemon's contract assets these types were generated from (definition: daemon ADR-0028). Clients compare it againstGET /api/v1/info.schema_digestto verify exact type/daemon parity at connect time.DAEMON_API_VERSION— the daemon'sapi_versionat generation time. Minor bumps add fields without breaking existing consumers; major bumps remove or rename payload fields, scopes, or capabilities — see ADR-0020 in the daemon repo.
Regeneration and release are automated end to end. The daemon's
release workflow fires a repository_dispatch (daemon-release) at
this repo, which drives this chain:
regenerate-on-daemon-releasechecks out the daemon at the released tag, regenerates all modules, stamps the constants, bumps the version, seeds a baseline changelog section, opens a PR from aregen/daemon-<tag>branch, and enables auto-merge.ciruns on the PR:Test(the suite) andRegen clean(re-runsmake generateagainst the branch's daemon tag and fails on any drift, so hand-edits to generated modules are caught).- Once the required checks are green the PR squash-merges;
tag-on-regen-mergethen pushesv<version>. - The tag triggers
release-on-tag→ GitHub Release →python-publish→ PyPI.
Manual fallback: workflow_dispatch with the tag, or the local
two-step flow above.
CI / release setup
The automation needs three one-time repository settings; without them the chain stops after step 1:
- A
RELEASE_PATsecret — a fine-grained PAT (or GitHub App token) withcontents: write+pull-requests: write. The regen PR and the release tag are pushed with it, because a branch/PR/tag created via the defaultGITHUB_TOKENdoes not trigger the downstream CI and release workflows (GitHub's recursive-workflow guard). - Branch protection on
mainrequiring theTestandRegen cleanstatus checks — auto-merge waits on these. - Allow auto-merge enabled in the repository settings.
What this package does NOT contain
- HTTP / WebSocket transport — see
openccu-loom-client(when published) for the higher-level client. - Any business logic — types only.
- Async helpers — types are framework-neutral.
Development
Parts of openccu-loom-types are developed with agentic AI assistance, primarily Claude Code. Submitted issues are likewise triaged and analysed with agentic help. Every change is still reviewed by a human maintainer and must pass the project's tests before it lands — the AI speeds up the work, it does not replace the review gate.
Contributions made with AI assistance are welcome and subject to the rules in AI_POLICY.md.
License
MIT. See LICENSE.
1 maintainer
Release files for openccu-loom-types 0.5.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openccu_loom_types-0.5.7.tar.gz | 65.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openccu_loom_types-0.5.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 129.0 kB
Release files / openccu_loom_types-0.5.7.tar.gz
| Download URL | openccu_loom_types-0.5.7.tar.gz |
|---|---|
| Size | 65.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db691c1172d5d3fddbd96d280f5a61d6ca064e20c502530ece8ff6a95594fd0d
|
|
BLAKE2b-256 checksum How to use checksums |
fc10e0cf0f5b39b52a442895838046c5975654c96b49baecef7e12c94140b5ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logRelease files / openccu_loom_types-0.5.7-py3-none-any.whl
| Download URL | openccu_loom_types-0.5.7-py3-none-any.whl |
|---|---|
| Size | 63.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6991e22ca61f1eca5dca24c6cc6c662feff7877f7c99ac46364a69ca13898ee6
|
|
BLAKE2b-256 checksum How to use checksums |
5a222906e9d5793aedff4c21ed78816e9b58918aa5fff710923fccb49291128b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency log
