piphi-runtime-kit-python 0.4.4__tar.gz → 0.4.6__tar.gz

{piphi_runtime_kit_python-0.4.4 → piphi_runtime_kit_python-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piphi-runtime-kit-python
-Version: 0.4.4
+Version: 0.4.6
 Summary: PiPhi Network runtime integration helpers
 Keywords: piphi,runtime,integration,iot
 Author-Email: KelvinSan <support@piphi.network>

{piphi_runtime_kit_python-0.4.4 → piphi_runtime_kit_python-0.4.6}/pyproject.toml

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

{piphi_runtime_kit_python-0.4.4 → piphi_runtime_kit_python-0.4.6}/src/piphi_runtime_kit_python/runtime/starter.py

@@ -3,15 +3,25 @@ from __future__ import annotations
 """Opinionated beginner-friendly starter helpers for PiPhi runtimes."""
 
 from dataclasses import dataclass, field
+from pathlib import Path
 from typing import Any
 
-from .config_sync import ConfigSyncCoordinator
+import httpx
+
+from .config_sync import (
+    DEFAULT_RUNTIME_VOLUME_DIR,
+    ConfigSyncCoordinator,
+    RuntimeConfigRehydrateResult,
+    SnapshotApplyCallable,
+    rehydrate_runtime_configs,
+)
 from .context import RuntimeContext
 from .events import DEFAULT_CORE_BASE_URL as DEFAULT_EVENTS_CORE_BASE_URL, EventClient
 from .health import build_runtime_diagnostics_response, build_runtime_health_response
+from .lifespan import DEFAULT_CORE_CLIENT_TIMEOUT_SECONDS
 from .registry import RuntimeRegistry
 from .telemetry import DEFAULT_CORE_BASE_URL as DEFAULT_TELEMETRY_CORE_BASE_URL, TelemetryClient
-from ..schemas import RuntimeEntitiesResponse
+from ..schemas import RuntimeConfig, RuntimeConfigSnapshot, RuntimeEntitiesResponse
 
 
 @dataclass(slots=True)
@@ -92,6 +102,37 @@ class RuntimeStarter:
             commands=commands,
         )
 
+    async def rehydrate_configs(
+        self,
+        *,
+        client: httpx.AsyncClient,
+        apply_snapshot: SnapshotApplyCallable,
+        config_model: type[RuntimeConfig] = RuntimeConfig,
+        snapshot_model: type[Any] = RuntimeConfigSnapshot,
+        timeout_seconds: float = DEFAULT_CORE_CLIENT_TIMEOUT_SECONDS,
+        snapshot_path: str | Path | None = None,
+        snapshot_volume_dir: str | Path = DEFAULT_RUNTIME_VOLUME_DIR,
+        raise_core_errors: bool = False,
+    ) -> RuntimeConfigRehydrateResult:
+        """Load startup configs from the mounted snapshot and then Core.
+
+        This is the recommended starter-level entry point. Integration authors
+        provide their typed config model and apply callback; the starter supplies
+        the shared runtime context and Core base URL.
+        """
+        return await rehydrate_runtime_configs(
+            runtime_context=self.runtime,
+            client=client,
+            apply_snapshot=apply_snapshot,
+            config_model=config_model,
+            snapshot_model=snapshot_model,
+            core_base_url=self.core_base_url,
+            timeout_seconds=timeout_seconds,
+            snapshot_path=snapshot_path,
+            snapshot_volume_dir=snapshot_volume_dir,
+            raise_core_errors=raise_core_errors,
+        )
+
 
 def build_entities_response(
     *,

{piphi_runtime_kit_python-0.4.4 → piphi_runtime_kit_python-0.4.6}/tests/test_runtime_starter.py

@@ -1,4 +1,7 @@
+import pytest
+
 from piphi_runtime_kit_python import (
+    RuntimeConfigSnapshot,
     RuntimeEntitiesResponse,
     RuntimeStarter,
     create_runtime_starter,
@@ -56,3 +59,56 @@ def test_runtime_starter_entities_response_wraps_runtime_entities() -> None:
     assert response.entities[0].available_commands[0].id == "toggle"
     assert response.capabilities == {"switch": {"kind": "action"}}
     assert response.commands == {"turn_on": {"description": "Turn on"}}
+
+
+class _CoreConfigResponse:
+    def __init__(self, payload):
+        self.payload = payload
+
+    def raise_for_status(self) -> None:
+        return None
+
+    def json(self):
+        return self.payload
+
+
+class _CoreConfigClient:
+    def __init__(self, payload):
+        self.payload = payload
+        self.requests: list[dict] = []
+
+    async def get(self, url: str, **kwargs):
+        self.requests.append({"url": url, **kwargs})
+        return _CoreConfigResponse(self.payload)
+
+
+@pytest.mark.asyncio
+async def test_runtime_starter_rehydrates_configs_with_shared_runtime_context() -> None:
+    starter = create_runtime_starter(
+        integration_id="demo-runtime",
+        integration_name="Demo Runtime",
+        core_base_url="http://core.local",
+    )
+    starter.runtime.auth.update(
+        container_id="container-1",
+        internal_token="secret-token",
+    )
+    client = _CoreConfigClient(
+        [{"config_data": {"id": "device-1", "name": "Kitchen"}}]
+    )
+    applied: list[list[str]] = []
+
+    async def apply_snapshot(snapshot: RuntimeConfigSnapshot) -> None:
+        applied.append([config.id for config in snapshot.configs])
+
+    result = await starter.rehydrate_configs(
+        client=client,
+        apply_snapshot=apply_snapshot,
+    )
+
+    assert result.core_applied is True
+    assert result.core_config_count == 1
+    assert applied == [["device-1"]]
+    assert client.requests[0]["url"] == (
+        "http://core.local/api/v2/integrations/config/fetch/all/by/container/internal"
+    )