openccu-loom-types 0.1.0__tar.gz

openccu_loom_types-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SukramJ
+
+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.

openccu_loom_types-0.1.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: openccu-loom-types
+Version: 0.1.0
+Summary: Generated Pydantic / enum types for the openccu-loom REST + WebSocket contract
+Author: OpenCCU-Loom authors
+License: MIT
+Project-URL: Homepage, https://github.com/SukramJ/openccu-loom-types-py
+Project-URL: Bug Tracker, https://github.com/SukramJ/openccu-loom-types-py/issues
+Project-URL: Source Repo, https://github.com/SukramJ/openccu-loom
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.6
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator[ruff]>=0.57; extra == "dev"
+Requires-Dist: pytest>=7.4; extra == "dev"
+Dynamic: license-file
+
+# openccu-loom-types-py
+
+Generated Pydantic models + enum definitions for the openccu-loom
+REST + WebSocket contract. Sister-repo to the
+[openccu-loom daemon](https://github.com/SukramJ/openccu-loom);
+publishable as `openccu-loom-types` on PyPI.
+
+## What this package provides
+
+- `openccu_loom_types.enums` — every enum from the daemon's
+  `pkg/hmenum`. Each enum is a `str`-typed Python `Enum` whose values
+  match the wire strings the CCU emits. Source of truth:
+  `assets/schemas/enums.json` in the openccu-loom repo.
+- `openccu_loom_types.rest` — Pydantic models for the REST surface.
+  Generated from `assets/openapi.yaml` via `datamodel-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 in `components.schemas` per ADR-0020).
+
+## Why this exists (asks.md C1 + C3)
+
+Higher-level clients (`py-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`):
+
+```sh
+# 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
+
+The package version (`pyproject.toml`) tracks the daemon's
+`api_version` (currently `1.0.0`). 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
+for the contract evolution policy.
+
+## What this package does NOT contain
+
+- HTTP / WebSocket transport — see `py-openccu-loom-client`
+  (when published) for the higher-level client.
+- Any business logic — types only.
+- Async helpers — types are framework-neutral.
+
+## License
+
+MIT. See [LICENSE](./LICENSE).

openccu_loom_types-0.1.0/README.md

@@ -0,0 +1,69 @@
+# openccu-loom-types-py
+
+Generated Pydantic models + enum definitions for the openccu-loom
+REST + WebSocket contract. Sister-repo to the
+[openccu-loom daemon](https://github.com/SukramJ/openccu-loom);
+publishable as `openccu-loom-types` on PyPI.
+
+## What this package provides
+
+- `openccu_loom_types.enums` — every enum from the daemon's
+  `pkg/hmenum`. Each enum is a `str`-typed Python `Enum` whose values
+  match the wire strings the CCU emits. Source of truth:
+  `assets/schemas/enums.json` in the openccu-loom repo.
+- `openccu_loom_types.rest` — Pydantic models for the REST surface.
+  Generated from `assets/openapi.yaml` via `datamodel-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 in `components.schemas` per ADR-0020).
+
+## Why this exists (asks.md C1 + C3)
+
+Higher-level clients (`py-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`):
+
+```sh
+# 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
+
+The package version (`pyproject.toml`) tracks the daemon's
+`api_version` (currently `1.0.0`). 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
+for the contract evolution policy.
+
+## What this package does NOT contain
+
+- HTTP / WebSocket transport — see `py-openccu-loom-client`
+  (when published) for the higher-level client.
+- Any business logic — types only.
+- Async helpers — types are framework-neutral.
+
+## License
+
+MIT. See [LICENSE](./LICENSE).

openccu_loom_types-0.1.0/openccu_loom_types/__init__.py

@@ -0,0 +1,20 @@
+# SPDX-License-Identifier: MIT
+# Copyright (C) 2026 OpenCCU-Loom authors.
+
+"""openccu-loom-types — generated typing bindings for the openccu-loom daemon.
+
+Submodules:
+
+- :mod:`openccu_loom_types.enums` — every enum from `pkg/hmenum`
+  (generated from `assets/schemas/enums.json`).
+- :mod:`openccu_loom_types.rest` — Pydantic models for the REST
+  surface (generated from `assets/openapi.yaml`).
+- :mod:`openccu_loom_types.ws` — Pydantic models for the WebSocket
+  envelope + push payloads (planned; currently bundled in
+  :mod:`openccu_loom_types.rest` until the schema-grouping in
+  openapi.yaml stabilises).
+
+See README.md for the regeneration workflow.
+"""
+
+__version__ = "0.1.0"