capture-runtime-client 0.4.0__py3-none-any.whl

capture_runtime_client/private/schemas/runtime-streaming-capabilities-v2.schema.json

@@ -0,0 +1,64 @@
+{
+  "$defs": {
+    "CaptureSourceKind": {
+      "enum": [
+        "pdf",
+        "image",
+        "audio"
+      ],
+      "title": "CaptureSourceKind",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "protocolVersion": {
+      "const": "2",
+      "default": "2",
+      "title": "Protocolversion",
+      "type": "string"
+    },
+    "captureKinds": {
+      "items": {
+        "$ref": "#/$defs/CaptureSourceKind"
+      },
+      "minItems": 1,
+      "title": "Capturekinds",
+      "type": "array"
+    },
+    "supportsProgressiveAudio": {
+      "default": true,
+      "title": "Supportsprogressiveaudio",
+      "type": "boolean"
+    },
+    "maxChunkBytes": {
+      "exclusiveMinimum": 0,
+      "maximum": 4194304,
+      "title": "Maxchunkbytes",
+      "type": "integer"
+    },
+    "checkpointIntervalMs": {
+      "exclusiveMinimum": 0,
+      "title": "Checkpointintervalms",
+      "type": "integer"
+    },
+    "heartbeatIntervalMs": {
+      "exclusiveMinimum": 0,
+      "title": "Heartbeatintervalms",
+      "type": "integer"
+    },
+    "stallTimeoutMs": {
+      "exclusiveMinimum": 0,
+      "title": "Stalltimeoutms",
+      "type": "integer"
+    }
+  },
+  "required": [
+    "maxChunkBytes",
+    "checkpointIntervalMs",
+    "heartbeatIntervalMs",
+    "stallTimeoutMs"
+  ],
+  "title": "RuntimeStreamingCapabilitiesV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/start-capture-v2.schema.json

@@ -0,0 +1,59 @@
+{
+  "$defs": {
+    "StructuringMode": {
+      "enum": [
+        "runtime",
+        "host"
+      ],
+      "title": "StructuringMode",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "protocolVersion": {
+      "const": "2",
+      "default": "2",
+      "title": "Protocolversion",
+      "type": "string"
+    },
+    "clientRequestId": {
+      "minLength": 1,
+      "title": "Clientrequestid",
+      "type": "string"
+    },
+    "ingestionId": {
+      "minLength": 1,
+      "title": "Ingestionid",
+      "type": "string"
+    },
+    "structuringMode": {
+      "$ref": "#/$defs/StructuringMode"
+    },
+    "targetLanguage": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Targetlanguage"
+    },
+    "startPolicy": {
+      "const": "eager",
+      "default": "eager",
+      "title": "Startpolicy",
+      "type": "string"
+    }
+  },
+  "required": [
+    "clientRequestId",
+    "ingestionId",
+    "structuringMode"
+  ],
+  "title": "StartCaptureV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/start-runtime-installation-v2.schema.json

@@ -0,0 +1,26 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "requirementId": {
+      "enum": [
+        "windowsml-ocr",
+        "whisper-primary",
+        "ollama-runtime",
+        "capture-ollama-model"
+      ],
+      "title": "Requirementid",
+      "type": "string"
+    },
+    "consent": {
+      "const": true,
+      "title": "Consent",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "requirementId",
+    "consent"
+  ],
+  "title": "StartRuntimeInstallationV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/start-runtime-model-installation-v2.schema.json

@@ -0,0 +1,21 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "optionId": {
+      "minLength": 1,
+      "title": "Optionid",
+      "type": "string"
+    },
+    "consent": {
+      "const": true,
+      "title": "Consent",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "optionId",
+    "consent"
+  ],
+  "title": "StartRuntimeModelInstallationV2",
+  "type": "object"
+}

capture_runtime_client/private/schemas/time-locator.schema.json

@@ -0,0 +1,27 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "kind": {
+      "const": "time",
+      "default": "time",
+      "title": "Kind",
+      "type": "string"
+    },
+    "startMs": {
+      "minimum": 0,
+      "title": "Startms",
+      "type": "integer"
+    },
+    "endMs": {
+      "exclusiveMinimum": 0,
+      "title": "Endms",
+      "type": "integer"
+    }
+  },
+  "required": [
+    "startMs",
+    "endMs"
+  ],
+  "title": "TimeLocator",
+  "type": "object"
+}

capture_runtime_client/py.typed

@@ -0,0 +1 @@
+

capture_runtime_client/transport.py

@@ -0,0 +1,158 @@
+"""Authenticated HTTP and deterministic in-memory transports."""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Mapping
+from dataclasses import dataclass
+from typing import Any, Protocol, cast
+from urllib.parse import urlsplit
+
+import httpx
+
+from .errors import CaptureTransportError
+
+
+def validate_loopback_base_url(value: str | int) -> str:
+    candidate = f"http://127.0.0.1:{value}" if isinstance(value, int) else value
+    parsed = urlsplit(candidate)
+    if (
+        parsed.scheme != "http"
+        or parsed.hostname not in {"127.0.0.1", "::1"}
+        or not parsed.port
+        or parsed.username
+        or parsed.password
+        or parsed.query
+        or parsed.fragment
+        or parsed.path not in {"", "/"}
+    ):
+        raise CaptureTransportError(
+            "Capture Runtime URL must be an HTTP loopback origin with an explicit port.",
+            code="unsafe_base_url",
+        )
+    return f"http://{parsed.hostname}:{parsed.port}"
+
+
+class RuntimeTransport(Protocol):
+    def request(self, method: str, path: str, **kwargs: Any) -> httpx.Response: ...
+
+    def stream(self, method: str, path: str, **kwargs: Any) -> Any: ...
+
+
+class HttpRuntimeTransport:
+    def __init__(
+        self,
+        *,
+        base_url: str | int,
+        bearer_token: str,
+        timeout_seconds: float = 30,
+        client: httpx.Client | None = None,
+    ) -> None:
+        self.base_url = validate_loopback_base_url(base_url)
+        if not bearer_token.strip():
+            raise ValueError("Capture Runtime bearer token must not be empty")
+        self._token = bearer_token
+        self._client = client or httpx.Client(timeout=timeout_seconds, follow_redirects=False)
+        self._owns_client = client is None
+
+    def request(self, method: str, path: str, **kwargs: Any) -> httpx.Response:
+        headers = dict(kwargs.pop("headers", {}) or {})
+        headers["Authorization"] = f"Bearer {self._token}"
+        try:
+            return self._client.request(method, f"{self.base_url}{path}", headers=headers, **kwargs)
+        except httpx.HTTPError as error:
+            raise CaptureTransportError(
+                "Capture Runtime transport request failed.", str(error)
+            ) from error
+
+    def stream(self, method: str, path: str, **kwargs: Any) -> Any:
+        headers = dict(kwargs.pop("headers", {}) or {})
+        headers["Authorization"] = f"Bearer {self._token}"
+        try:
+            context = self._client.stream(
+                method, f"{self.base_url}{path}", headers=headers, **kwargs
+            )
+            return _HttpxStream(context)
+        except httpx.HTTPError as error:
+            raise CaptureTransportError(
+                "Capture Runtime transport stream failed.", str(error)
+            ) from error
+
+    def close(self) -> None:
+        if self._owns_client:
+            self._client.close()
+
+    def __enter__(self) -> HttpRuntimeTransport:
+        return self
+
+    def __exit__(self, *_args: object) -> None:
+        self.close()
+
+
+@dataclass(frozen=True, slots=True)
+class InMemoryRoute:
+    method: str
+    path: str
+    handler: Callable[[httpx.Request], httpx.Response]
+
+
+class InMemoryRuntimeTransport:
+    """Small adapter for client contract tests without sockets or credentials."""
+
+    def __init__(
+        self,
+        routes: Mapping[tuple[str, str], Callable[[httpx.Request], httpx.Response]] | None = None,
+    ) -> None:
+        self._routes = dict(routes or {})
+
+    def request(self, method: str, path: str, **kwargs: Any) -> httpx.Response:
+        request = httpx.Request(method, f"http://capture.test{path}", **kwargs)
+        handler = self._routes.get((method.upper(), path))
+        if handler is None:
+            return httpx.Response(
+                404,
+                json={"error": {"code": "not_found", "message": "Route not found."}},
+                request=request,
+            )
+        return handler(request)
+
+    def stream(self, method: str, path: str, **kwargs: Any) -> Any:
+        response = self.request(method, path, **kwargs)
+        return _InMemoryStream(response)
+
+
+class _InMemoryStream:
+    def __init__(self, response: httpx.Response) -> None:
+        self.response = response
+
+    def __enter__(self) -> httpx.Response:
+        return self.response
+
+    def __exit__(self, *_args: object) -> None:
+        self.response.close()
+
+
+class _HttpxStream:
+    """Map deferred httpx stream failures to the SDK transport taxonomy."""
+
+    def __init__(self, context: Any) -> None:
+        self._context = context
+
+    def __enter__(self) -> httpx.Response:
+        try:
+            return cast(httpx.Response, self._context.__enter__())
+        except httpx.HTTPError as error:
+            raise CaptureTransportError(
+                "Capture Runtime transport stream failed.", str(error)
+            ) from error
+
+    def __exit__(self, *args: object) -> Any:
+        return self._context.__exit__(*args)
+
+
+__all__ = [
+    "HttpRuntimeTransport",
+    "InMemoryRoute",
+    "InMemoryRuntimeTransport",
+    "RuntimeTransport",
+    "validate_loopback_base_url",
+]

capture_runtime_client-0.4.0.dist-info/METADATA

@@ -0,0 +1,18 @@
+Metadata-Version: 2.5
+Name: capture-runtime-client
+Version: 0.4.0
+Summary: Capture Runtime HTTP, in-memory, discovery, and protocol client SDK.
+License: MIT
+Requires-Python: <3.15,>=3.12
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: pydantic<3.0.0,>=2.13.4
+Description-Content-Type: text/markdown
+
+# capture-runtime-client
+
+Backend-side Capture Runtime client SDK.  It owns loopback endpoint
+validation, readiness/schema-hash negotiation, authenticated HTTP and
+deterministic in-memory transports, canonical v2 request methods, SSE decoding, and
+redacted common errors. Generated Pydantic models are private SDK build input;
+consumers import them from `capture_runtime_client`, never from a generated
+contracts package.

capture_runtime_client-0.4.0.dist-info/RECORD

@@ -0,0 +1,48 @@
+capture_runtime_client/__init__.py,sha256=bm0yIgnJWXyMdBtloG6Q3cg5WI4ejj4VJ7IEOVTNUoc,1176
+capture_runtime_client/client.py,sha256=kFkXdbWrpYHIMn7AZwKZkwaIabpwtESA8fYc7VHXpvo,34987
+capture_runtime_client/codec.py,sha256=whub3Hhhnq_PT9VKRF8HB64tTZlVvs30Ktxm2lsWyMA,4359
+capture_runtime_client/contracts.py,sha256=Xm-qPH4N8cl9eDUXUE0IZqIOs86Pp62acEVZSJ_mrCA,7421
+capture_runtime_client/errors.py,sha256=6kAX4pvML46eirEfohYoEnlhrE9dqmQVBTvQuS5wBQ8,4977
+capture_runtime_client/transport.py,sha256=GVXJg7W4QBD90M5u3XHdakkSLU8GpTpk44J7CxKyO8M,5261
+capture_runtime_client/private/__init__.py,sha256=eGy1FewPqP3dCz0IIY3GVKcokF_Nq4ZtuPB-eLzNK7U,79
+capture_runtime_client/private/generated_models.py,sha256=kvA1rVQAJTCKG5q2-37NqSJQwN0XwT7q8QOs3nVaQuo,21853
+capture_runtime_client/private/assets/__init__.py,sha256=irUWjqjZ2DBo1-jZnZfpg4LVECR9vMsOB362AWFVjzw,55
+capture_runtime_client/private/schemas/__init__.py,sha256=mbZqwM1hxtMr-eRDGYtV6YDCM3mJsA-CzbWBf7WqDN8,64
+capture_runtime_client/private/schemas/capture-block.schema.json,sha256=aZPYJbCqKZdmtBmWDM4f95X0SbzkykGUuqaQ7XXuxgg,3205
+capture_runtime_client/private/schemas/capture-document.schema.json,sha256=hQr9IS0EnCXaQdOGe6VHdFGmosbH5B8Rb-YPJrajUzU,8222
+capture_runtime_client/private/schemas/capture-engine.schema.json,sha256=T-0KBYwRiH_KdQy6VH3PoR2fLUZWmB5WaD4mnXfsmWM,719
+capture_runtime_client/private/schemas/capture-event-v2.schema.json,sha256=i45sJHsNwZ4pr8K_WLrUAR3DxqKMpmdfeO_tncJBxuo,6470
+capture_runtime_client/private/schemas/capture-failure-v2.schema.json,sha256=H5B_e48RwKtgh5SEZdBXUDgqJxrTr2_8MCKUIWOIpAw,740
+capture_runtime_client/private/schemas/capture-operation-v2.schema.json,sha256=QGsWYzmfwG3CHvBfLk7DN6oNQxR1NiQLafR35-cnpw4,4359
+capture_runtime_client/private/schemas/capture-source.schema.json,sha256=4GtLXxu_UnG8UkykRctxrV2TdQzu7MYxg8TvqT7SCn0,636
+capture_runtime_client/private/schemas/error-body-v2.schema.json,sha256=VOHKQUPuI1OK6c6nKHy1B3BcQT40NE2-SL6I-dfx-fM,600
+capture_runtime_client/private/schemas/error-envelope-v2.schema.json,sha256=IeotQdcv1hEja0rKzGwFI4tnBRjpJYYBZiF2PjTsRMA,983
+capture_runtime_client/private/schemas/finalize-ingestion-v2.schema.json,sha256=oi3X62-8zxe07Hwk9OUqn0D3WCSiiYOsGu250m8cqH8,537
+capture_runtime_client/private/schemas/ingestion-v2.schema.json,sha256=OeMsg1hpMsyBK81lU8W-YtEm7nxFdvzLj7XZvVtCmeg,2603
+capture_runtime_client/private/schemas/open-ingestion-v2.schema.json,sha256=9fWf-YYditn69Zywc9SP_-AaR51Zsgi_y5HJXOms-r0,1600
+capture_runtime_client/private/schemas/page-locator.schema.json,sha256=Bs73ZGASiTmRjuFpEpZjyDdEuuYwerkLRhZLvZIePN8,915
+capture_runtime_client/private/schemas/partial-capture-v2.schema.json,sha256=GRBWvlGRCpd0FiqTktzbg2a8KCM6O8JdNGVpzbIgzZg,5938
+capture_runtime_client/private/schemas/raw-capture-segment.schema.json,sha256=zfgSVhfqYjYYFHnJUx74LVN1zANV1frvaMwydDepH7k,2671
+capture_runtime_client/private/schemas/raw-capture.schema.json,sha256=0CWoOs7fzxdnYceUzuk-TQ7K996296eeVT960dk9bXg,5832
+capture_runtime_client/private/schemas/report-structuring-failure-v2.schema.json,sha256=4iI0TuqiAl4S6dZHGXKyI8ju5bcROEFHUODn8bLnldc,554
+capture_runtime_client/private/schemas/runtime-artifact-descriptor-v2.schema.json,sha256=jGlc1Xhmj1b-EiYeNaDK4EzFO1ekNTxthefJdqGjd5I,684
+capture_runtime_client/private/schemas/runtime-installation-v2.schema.json,sha256=0a_EyvyOr2ncwoK6ODUWbSXltWzC-Rvd-Efio5xi26Y,2648
+capture_runtime_client/private/schemas/runtime-installations-v2.schema.json,sha256=pjZiIJSSHge6hPCiyxIVXgBbYNScBtUj963N1lYCX4Q,3269
+capture_runtime_client/private/schemas/runtime-model-installation-v2.schema.json,sha256=qAZPZ9pfDkhfxHKPtEmXxW3P8a9NTmRL9ZYNSlpS8aU,2521
+capture_runtime_client/private/schemas/runtime-model-installations-v2.schema.json,sha256=kSaneYcOK3S29_uc3L0wTHS2hKM9bfPu4x6gyXOHerw,3137
+capture_runtime_client/private/schemas/runtime-model-option-v2.schema.json,sha256=B5RGZC9gHN1Qyqym1WnMM2BOWjHpsENrTEzFXOnnuM0,1618
+capture_runtime_client/private/schemas/runtime-model-options-v2.schema.json,sha256=GFGwkSS57f_yjfTifqPO09hUnnGcXMc7BXU520ct-y8,2371
+capture_runtime_client/private/schemas/runtime-ready.schema.json,sha256=P_k3l9xCjjMNvOwb8f9XXUzInqJpRne_yNuXZFFR27s,1891
+capture_runtime_client/private/schemas/runtime-requirement-v2.schema.json,sha256=F2U-VB_NuhMN6uUVjKSLchathZAdoYFZNktl941k1Po,2552
+capture_runtime_client/private/schemas/runtime-requirements-v2.schema.json,sha256=knWrE6Bxdd7hF0_FLRLw5ncVyrDx9GDGLAY_m5RcTiY,3174
+capture_runtime_client/private/schemas/runtime-streaming-capabilities-v2.schema.json,sha256=k8eRRAoYLI3Ktq9rsnEHlEsK_YgHnrYl84CEnzCnLjE,1437
+capture_runtime_client/private/schemas/start-capture-v2.schema.json,sha256=1rq6vTBzYOiA4fTFovcupwC2tOQUPUYxV2dFZy4pwBI,1169
+capture_runtime_client/private/schemas/start-runtime-installation-v2.schema.json,sha256=uYV_zxI9OziiaHn0ODWaEFMyMWwcSFDKu0nuPuDDnVk,515
+capture_runtime_client/private/schemas/start-runtime-model-installation-v2.schema.json,sha256=Iwk0lYqsslVhvjfHVB_MoBMS5xEyAyCRO-Pqyq30X-o,388
+capture_runtime_client/private/schemas/time-locator.schema.json,sha256=ewNnOUItQz_54-8ag9mwDseS2im5NNO237V8f577QDI,487
+capture_runtime_client/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+capture_runtime_client/private/assets/contract-set.json,sha256=W5O8tVesygNDhrbp5HUC7-yRIQMx7Our2cRwGW01_sM,77203
+capture_runtime_client/private/assets/contract-set.sha256,sha256=JZWtbJ20QvknCz7QewqyNT1kovdF_EA1RyF8E0Lltw4,66
+capture_runtime_client-0.4.0.dist-info/METADATA,sha256=gqb8S6xSXcuped6fHVJsAea_Sv9p0I1U6u3Uj_SI_TU,725
+capture_runtime_client-0.4.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+capture_runtime_client-0.4.0.dist-info/RECORD,,

capture_runtime_client-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any