piphi-runtime-kit-python 0.3.0__tar.gz → 0.4.1__tar.gz

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piphi-runtime-kit-python
-Version: 0.3.0
+Version: 0.4.1
 Summary: PiPhi Network runtime integration helpers
 Keywords: piphi,runtime,integration,iot
 Author-Email: KelvinSan <support@piphi.network>
@@ -113,18 +113,28 @@ hide vendor logic behind an overly magical abstraction.
 
 The package currently supports Python `>=3.11`.
 
-Install from a local checkout:
+Install from PyPI:
 
 ```bash
-pdm add /path/to/piphi-runtime-kit-python
+pdm add piphi-runtime-kit-python
 ```
 
 If you need the optional FastAPI helpers:
 
 ```bash
-pdm add "/path/to/piphi-runtime-kit-python[fastapi]"
+pdm add "piphi-runtime-kit-python[fastapi]"
 ```
 
+If you prefer `pip`:
+
+```bash
+pip install piphi-runtime-kit-python
+```
+
+Package page:
+
+- https://pypi.org/project/piphi-runtime-kit-python/0.3.0/
+
 ## First 15 Minutes
 
 If you want the shortest path to a working runtime, do this:
@@ -160,9 +170,71 @@ These are the most common runtime routes and what they are for.
 | `/deconfigure` | `POST` | Usually | Remove one config | `RuntimeConfigRemoveResponse` |
 | `/events` | `GET` | Common | Show recent local runtime events | `build_event_list_response(...)` |
 | `/state` | `GET` | Common | Show current runtime state | `registry.entries`, `registry.state_snapshots` |
-| `/entities` | `GET` | Integration-specific | Show normalized entity list | integration-owned |
+| `/entities` | `GET` | Integration-specific | Show normalized entity list | `build_entities_response(...)`, `starter.entities_response(...)` |
 | `/ui` or `/ui-config` | `GET` | Optional | Return config UI metadata | integration-owned |
 
+## Modeling `/entities`
+
+For simple integrations, `/entities` can still be a plain list of generic
+entities.
+
+For smart-home and multi-device integrations, PiPhi now recommends a richer
+runtime-owned entity shape that ties each entity to a real saved config or
+device. That lets Core make better device-first dashboard suggestions, and it
+gives the frontend enough context to render better widget defaults for plugs,
+bulbs, thermostats, and other device-specific entities.
+
+Recommended fields:
+
+- `id`: stable runtime entity id
+- `name`: user-facing label
+- `capabilities`: actual capabilities for that specific device
+- `config_id` / `configId`: PiPhi config UUID when available
+- `device_id` / `deviceId`: integration-native device id
+- `device_type` / `device_class`: values like `plug`, `bulb`, `sensor`, `climate`
+- `entity_type`: values like `switch`, `light`, `sensor`, `media`
+- `dashboard.allowed_widgets`, `dashboard.default_widget`, `dashboard.recommended_widgets`: optional UI hints
+
+The SDK now includes `RuntimeEntityResponse`, `RuntimeEntitiesResponse`,
+`build_entities_response(...)`, and `starter.entities_response(...)` to make
+that payload easier to return.
+
+The helper returns the standard wrapper shape:
+
+- `entities`: the runtime-owned list you generated
+- `capabilities`: optional manifest capability metadata
+- `commands`: optional manifest command metadata
+
+```python
+from piphi_runtime_kit_python import build_entities_response
+
+@app.get("/entities")
+async def entities() -> dict[str, Any]:
+    return build_entities_response(
+        entities=[
+            {
+                "id": "office-plug",
+                "name": "Office Plug",
+                "config_id": "core-config-uuid",
+                "device_id": "office-plug",
+                "device_class": "plug",
+                "entity_type": "switch",
+                "capabilities": ["switch", "power", "energy_today"],
+                "dashboard": {
+                    "allowed_widgets": ["tile", "button", "stat"],
+                    "default_widget": "tile",
+                },
+            }
+        ],
+        capabilities=manifest["capabilities"],
+        commands=manifest.get("commands", {}),
+    ).model_dump(exclude_none=True)
+```
+
+If you are already using the starter object, the same response can be built with
+`starter.entities_response(...)` instead of calling the standalone helper
+directly.
+
 ## UI Config Endpoints
 
 Many integrations expose `/ui` or `/ui-config` so the PiPhi frontend knows how

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/README.md

@@ -87,18 +87,28 @@ hide vendor logic behind an overly magical abstraction.
 
 The package currently supports Python `>=3.11`.
 
-Install from a local checkout:
+Install from PyPI:
 
 ```bash
-pdm add /path/to/piphi-runtime-kit-python
+pdm add piphi-runtime-kit-python
 ```
 
 If you need the optional FastAPI helpers:
 
 ```bash
-pdm add "/path/to/piphi-runtime-kit-python[fastapi]"
+pdm add "piphi-runtime-kit-python[fastapi]"
 ```
 
+If you prefer `pip`:
+
+```bash
+pip install piphi-runtime-kit-python
+```
+
+Package page:
+
+- https://pypi.org/project/piphi-runtime-kit-python/0.3.0/
+
 ## First 15 Minutes
 
 If you want the shortest path to a working runtime, do this:
@@ -134,9 +144,71 @@ These are the most common runtime routes and what they are for.
 | `/deconfigure` | `POST` | Usually | Remove one config | `RuntimeConfigRemoveResponse` |
 | `/events` | `GET` | Common | Show recent local runtime events | `build_event_list_response(...)` |
 | `/state` | `GET` | Common | Show current runtime state | `registry.entries`, `registry.state_snapshots` |
-| `/entities` | `GET` | Integration-specific | Show normalized entity list | integration-owned |
+| `/entities` | `GET` | Integration-specific | Show normalized entity list | `build_entities_response(...)`, `starter.entities_response(...)` |
 | `/ui` or `/ui-config` | `GET` | Optional | Return config UI metadata | integration-owned |
 
+## Modeling `/entities`
+
+For simple integrations, `/entities` can still be a plain list of generic
+entities.
+
+For smart-home and multi-device integrations, PiPhi now recommends a richer
+runtime-owned entity shape that ties each entity to a real saved config or
+device. That lets Core make better device-first dashboard suggestions, and it
+gives the frontend enough context to render better widget defaults for plugs,
+bulbs, thermostats, and other device-specific entities.
+
+Recommended fields:
+
+- `id`: stable runtime entity id
+- `name`: user-facing label
+- `capabilities`: actual capabilities for that specific device
+- `config_id` / `configId`: PiPhi config UUID when available
+- `device_id` / `deviceId`: integration-native device id
+- `device_type` / `device_class`: values like `plug`, `bulb`, `sensor`, `climate`
+- `entity_type`: values like `switch`, `light`, `sensor`, `media`
+- `dashboard.allowed_widgets`, `dashboard.default_widget`, `dashboard.recommended_widgets`: optional UI hints
+
+The SDK now includes `RuntimeEntityResponse`, `RuntimeEntitiesResponse`,
+`build_entities_response(...)`, and `starter.entities_response(...)` to make
+that payload easier to return.
+
+The helper returns the standard wrapper shape:
+
+- `entities`: the runtime-owned list you generated
+- `capabilities`: optional manifest capability metadata
+- `commands`: optional manifest command metadata
+
+```python
+from piphi_runtime_kit_python import build_entities_response
+
+@app.get("/entities")
+async def entities() -> dict[str, Any]:
+    return build_entities_response(
+        entities=[
+            {
+                "id": "office-plug",
+                "name": "Office Plug",
+                "config_id": "core-config-uuid",
+                "device_id": "office-plug",
+                "device_class": "plug",
+                "entity_type": "switch",
+                "capabilities": ["switch", "power", "energy_today"],
+                "dashboard": {
+                    "allowed_widgets": ["tile", "button", "stat"],
+                    "default_widget": "tile",
+                },
+            }
+        ],
+        capabilities=manifest["capabilities"],
+        commands=manifest.get("commands", {}),
+    ).model_dump(exclude_none=True)
+```
+
+If you are already using the starter object, the same response can be built with
+`starter.entities_response(...)` instead of calling the standalone helper
+directly.
+
 ## UI Config Endpoints
 
 Many integrations expose `/ui` or `/ui-config` so the PiPhi frontend knows how

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "piphi-runtime-kit-python"
-version = "0.3.0"
+version = "0.4.1"
 description = "PiPhi Network runtime integration helpers"
 authors = [
     { name = "KelvinSan", email = "support@piphi.network" },

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/src/piphi_runtime_kit_python/__init__.py

@@ -70,7 +70,7 @@ from .runtime.mqtt import (
 )
 from .runtime.registry import RuntimeRegistry
 from .runtime.state import RuntimeProcessState
-from .runtime.starter import RuntimeStarter, create_runtime_starter
+from .runtime.starter import RuntimeStarter, build_entities_response, create_runtime_starter
 from .runtime.tasks import create_tracked_task, shutdown_background_tasks, track_background_task
 from .runtime.telemetry import TelemetryClient, build_core_auth_headers
 from .schemas import (
@@ -80,6 +80,9 @@ from .schemas import (
     IntegrationCommandRequest,
     IntegrationDiscoveryRequest,
     IntegrationDiscoveryResponse,
+    RuntimeEntityDashboardResponse,
+    RuntimeEntitiesResponse,
+    RuntimeEntityResponse,
     IntegrationEventIngestResponse,
     IntegrationEventListResponse,
     IntegrationEventRequest,
@@ -110,6 +113,9 @@ __all__ = [
     "IntegrationCommandRequest",
     "IntegrationDiscoveryRequest",
     "IntegrationDiscoveryResponse",
+    "RuntimeEntityDashboardResponse",
+    "RuntimeEntitiesResponse",
+    "RuntimeEntityResponse",
     "IntegrationEventRequest",
     "RuntimeAuthContext",
     "RuntimeAuthHeaders",
@@ -141,6 +147,7 @@ __all__ = [
     "build_core_auth_headers",
     "build_config_apply_response",
     "build_config_remove_response",
+    "build_entities_response",
     "build_runtime_auth_headers",
     "build_runtime_diagnostics_response",
     "build_runtime_health_response",

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/src/piphi_runtime_kit_python/runtime/starter.py

@@ -11,6 +11,7 @@ from .events import DEFAULT_CORE_BASE_URL as DEFAULT_EVENTS_CORE_BASE_URL, Event
 from .health import build_runtime_diagnostics_response, build_runtime_health_response
 from .registry import RuntimeRegistry
 from .telemetry import DEFAULT_CORE_BASE_URL as DEFAULT_TELEMETRY_CORE_BASE_URL, TelemetryClient
+from ..schemas import RuntimeEntitiesResponse
 
 
 @dataclass(slots=True)
@@ -77,6 +78,34 @@ class RuntimeStarter:
             },
         )
 
+    def entities_response(
+        self,
+        *,
+        entities: list[dict[str, Any]],
+        capabilities: dict[str, Any] | None = None,
+        commands: dict[str, Any] | None = None,
+    ) -> RuntimeEntitiesResponse:
+        """Build the standard /entities response body for this runtime."""
+        return build_entities_response(
+            entities=entities,
+            capabilities=capabilities,
+            commands=commands,
+        )
+
+
+def build_entities_response(
+    *,
+    entities: list[dict[str, Any]],
+    capabilities: dict[str, Any] | None = None,
+    commands: dict[str, Any] | None = None,
+) -> RuntimeEntitiesResponse:
+    """Return the standard runtime /entities response wrapper."""
+    return RuntimeEntitiesResponse(
+        entities=entities,
+        capabilities=capabilities or {},
+        commands=commands or {},
+    )
+
 
 def create_runtime_starter(
     *,

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/src/piphi_runtime_kit_python/schemas.py

@@ -6,7 +6,7 @@ from datetime import datetime, timezone
 from enum import Enum
 from typing import Any
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field
 
 
 class RuntimeConfig(BaseModel):
@@ -74,6 +74,68 @@ class IntegrationCommandRequest(BaseModel):
     args: dict[str, Any] = Field(default_factory=dict)
 
 
+class RuntimeEntityDashboardResponse(BaseModel):
+    """Optional per-entity dashboard hints returned by a runtime."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    allowed_widgets: list[str] = Field(
+        default_factory=list,
+        validation_alias=AliasChoices("allowed_widgets", "allowedWidgets"),
+    )
+    default_widget: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("default_widget", "defaultWidget"),
+    )
+    recommended_widgets: list[str] = Field(
+        default_factory=list,
+        validation_alias=AliasChoices("recommended_widgets", "recommendedWidgets"),
+    )
+    metadata: dict[str, Any] = Field(default_factory=dict)
+
+
+class RuntimeEntityResponse(BaseModel):
+    """One live runtime entity tied to a configured device/account."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    id: str
+    name: str
+    capabilities: list[str] = Field(default_factory=list)
+    config_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("config_id", "configId"),
+    )
+    device_id: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("device_id", "deviceId"),
+    )
+    device_type: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("device_type", "deviceType"),
+    )
+    device_class: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("device_class", "deviceClass"),
+    )
+    entity_type: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("entity_type", "entityType"),
+    )
+    dashboard: RuntimeEntityDashboardResponse | None = None
+    metadata: dict[str, Any] = Field(default_factory=dict)
+
+
+class RuntimeEntitiesResponse(BaseModel):
+    """Standard response body returned by runtime /entities endpoints."""
+
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    entities: list[RuntimeEntityResponse] = Field(default_factory=list)
+    capabilities: dict[str, Any] = Field(default_factory=dict)
+    commands: dict[str, Any] = Field(default_factory=dict)
+
+
 class IntegrationEventRequest(BaseModel):
     """Generic event payload emitted by a runtime integration."""
     event_type: str

piphi_runtime_kit_python-0.4.1/tests/test_runtime_starter.py

@@ -0,0 +1,53 @@
+from piphi_runtime_kit_python import (
+    RuntimeEntitiesResponse,
+    RuntimeStarter,
+    create_runtime_starter,
+)
+
+
+def test_create_runtime_starter_bundles_common_runtime_parts() -> None:
+    starter = create_runtime_starter(
+        integration_id="demo-runtime",
+        integration_name="Demo Runtime",
+        version="0.1.0",
+        max_recent_events=25,
+    )
+
+    assert isinstance(starter, RuntimeStarter)
+    assert starter.integration_metadata == {
+        "id": "demo-runtime",
+        "name": "Demo Runtime",
+        "version": "0.1.0",
+    }
+    assert starter.registry.max_recent_events == 25
+    assert starter.telemetry_client.process_state is starter.runtime.process_state
+    assert starter.event_client.process_state is starter.runtime.process_state
+    assert starter.config_sync.process_state is starter.runtime.process_state
+
+
+def test_runtime_starter_entities_response_wraps_runtime_entities() -> None:
+    starter = create_runtime_starter(
+        integration_id="demo-runtime",
+        integration_name="Demo Runtime",
+    )
+
+    response = starter.entities_response(
+        entities=[
+            {
+                "id": "office-plug",
+                "name": "Office Plug",
+                "capabilities": ["switch", "power"],
+                "config_id": "cfg-1",
+                "device_id": "office-plug",
+                "device_class": "plug",
+            }
+        ],
+        capabilities={"switch": {"kind": "action"}},
+        commands={"turn_on": {"description": "Turn on"}},
+    )
+
+    assert isinstance(response, RuntimeEntitiesResponse)
+    assert response.entities[0].name == "Office Plug"
+    assert response.entities[0].device_class == "plug"
+    assert response.capabilities == {"switch": {"kind": "action"}}
+    assert response.commands == {"turn_on": {"description": "Turn on"}}

{piphi_runtime_kit_python-0.3.0 → piphi_runtime_kit_python-0.4.1}/tests/test_schemas_matrix.py

@@ -16,6 +16,9 @@ from piphi_runtime_kit_python import (
     RuntimeConfigSnapshot,
     RuntimeConfigSyncResponse,
     RuntimeDiagnosticsResponse,
+    RuntimeEntitiesResponse,
+    RuntimeEntityDashboardResponse,
+    RuntimeEntityResponse,
     RuntimeHealthResponse,
     TelemetryPayload,
 )
@@ -72,6 +75,48 @@ def test_integration_event_request_defaults_payload() -> None:
     assert request.payload == {}
 
 
+def test_runtime_entity_models_support_aliases_and_defaults() -> None:
+    entity = RuntimeEntityResponse.model_validate(
+        {
+            "id": "office-plug",
+            "name": "Office Plug",
+            "capabilities": ["switch", "power"],
+            "configId": "cfg-1",
+            "deviceId": "office-plug",
+            "deviceClass": "plug",
+            "entityType": "switch",
+            "dashboard": {
+                "allowedWidgets": ["tile", "stat"],
+                "defaultWidget": "tile",
+                "recommendedWidgets": ["tile"],
+            },
+        }
+    )
+
+    assert entity.config_id == "cfg-1"
+    assert entity.device_id == "office-plug"
+    assert entity.device_class == "plug"
+    assert entity.entity_type == "switch"
+    assert entity.dashboard is not None
+    assert entity.dashboard.allowed_widgets == ["tile", "stat"]
+    assert entity.dashboard.default_widget == "tile"
+    assert entity.dashboard.recommended_widgets == ["tile"]
+
+
+def test_runtime_entities_response_defaults_cleanly() -> None:
+    response = RuntimeEntitiesResponse()
+    assert response.entities == []
+    assert response.capabilities == {}
+    assert response.commands == {}
+
+
+def test_runtime_entity_dashboard_defaults_metadata() -> None:
+    dashboard = RuntimeEntityDashboardResponse()
+    assert dashboard.allowed_widgets == []
+    assert dashboard.recommended_widgets == []
+    assert dashboard.metadata == {}
+
+
 def test_event_list_and_ingest_responses_default_cleanly() -> None:
     assert IntegrationEventListResponse().events == []
     assert IntegrationEventIngestResponse().status == "accepted"
@@ -121,4 +166,3 @@ def test_core_event_payload_model_dump_json_serializes_enums_and_datetimes() ->
     assert dumped["severity"] == "error"
     assert dumped["transport"] == "mqtt"
     assert dumped["ts"].endswith("Z")
-

piphi_runtime_kit_python-0.3.0/tests/test_runtime_starter.py

@@ -1,21 +0,0 @@
-from piphi_runtime_kit_python import RuntimeStarter, create_runtime_starter
-
-
-def test_create_runtime_starter_bundles_common_runtime_parts() -> None:
-    starter = create_runtime_starter(
-        integration_id="demo-runtime",
-        integration_name="Demo Runtime",
-        version="0.1.0",
-        max_recent_events=25,
-    )
-
-    assert isinstance(starter, RuntimeStarter)
-    assert starter.integration_metadata == {
-        "id": "demo-runtime",
-        "name": "Demo Runtime",
-        "version": "0.1.0",
-    }
-    assert starter.registry.max_recent_events == 25
-    assert starter.telemetry_client.process_state is starter.runtime.process_state
-    assert starter.event_client.process_state is starter.runtime.process_state
-    assert starter.config_sync.process_state is starter.runtime.process_state