syvain-metrics-api-client 0.0.57__tar.gz

syvain_metrics_api_client-0.0.57/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.3
+Name: syvain-metrics-api-client
+Version: 0.0.57
+Summary: Typed Python client for the Syvain Metrics REST API
+Requires-Dist: niquests>=3.16.0
+Requires-Dist: pydantic>=2.13.3
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: pytest>=8.0.0 ; extra == 'dev'
+Requires-Dist: ruff>=0.15.12 ; extra == 'dev'
+Requires-Dist: ty>=0.0.34 ; extra == 'dev'
+Requires-Python: >=3.10
+Provides-Extra: dev

syvain_metrics_api_client-0.0.57/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "syvain-metrics-api-client"
+version = "0.0.57"
+description = "Typed Python client for the Syvain Metrics REST API"
+requires-python = ">=3.10"
+dependencies = ["niquests>=3.16.0", "pydantic>=2.13.3", "typing-extensions>=4.15.0"]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0.0", "ruff>=0.15.12", "ty>=0.0.34"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[build-system]
+requires = ["uv_build>=0.11.9,<0.12"]
+build-backend = "uv_build"

syvain_metrics_api_client-0.0.57/src/syvain_metrics_api_client/__init__.py

@@ -0,0 +1,99 @@
+from syvain_metrics_api_client.auth import (
+    ClientCredentials,
+    MetricsApiAuthError,
+    cli_auth_path,
+    load_cli_auth,
+    normalize_metrics_host,
+)
+from syvain_metrics_api_client.client import (
+    MetricsApiError,
+    MetricsApiRequestError,
+    MetricsApiResponseError,
+    SyvainMetricsApiClient,
+)
+from syvain_metrics_api_client.types import (
+    Annotation,
+    AnnotationCreateInput,
+    AnnotationsResponse,
+    AuthStatusResponse,
+    ComparisonMetricSeries,
+    Experiment,
+    ExperimentAnnotationResponse,
+    ExperimentCreateInput,
+    ExperimentResponse,
+    ExperimentsResponse,
+    ExperimentStatusError,
+    ExperimentStatusUpdateInput,
+    Folder,
+    FolderContentsResponse,
+    FolderCreateInput,
+    FolderPatchInput,
+    FolderResponse,
+    FoldersResponse,
+    IngestCreateInput,
+    IngestResponse,
+    IngestionKey,
+    IngestionKeyCreateInput,
+    IngestionKeyCreateResponse,
+    IngestionKeyResponse,
+    IngestionKeysResponse,
+    JsonObject,
+    JsonPayload,
+    JsonValue,
+    MetricCatalogItem,
+    MetricCatalogMetadataValue,
+    MetricCatalogResponse,
+    MetricCatalogValues,
+    MetricCatalogValuesResponse,
+    MetricCreateInput,
+    MetricEventRow,
+    RowsResponse,
+)
+
+__all__ = [
+    "Annotation",
+    "AnnotationCreateInput",
+    "AnnotationsResponse",
+    "AuthStatusResponse",
+    "ClientCredentials",
+    "ComparisonMetricSeries",
+    "Experiment",
+    "ExperimentAnnotationResponse",
+    "ExperimentCreateInput",
+    "ExperimentResponse",
+    "ExperimentsResponse",
+    "ExperimentStatusError",
+    "ExperimentStatusUpdateInput",
+    "Folder",
+    "FolderContentsResponse",
+    "FolderCreateInput",
+    "FolderPatchInput",
+    "FolderResponse",
+    "FoldersResponse",
+    "IngestCreateInput",
+    "IngestResponse",
+    "IngestionKey",
+    "IngestionKeyCreateInput",
+    "IngestionKeyCreateResponse",
+    "IngestionKeyResponse",
+    "IngestionKeysResponse",
+    "JsonObject",
+    "JsonPayload",
+    "JsonValue",
+    "MetricCatalogItem",
+    "MetricCatalogMetadataValue",
+    "MetricCatalogResponse",
+    "MetricCatalogValues",
+    "MetricCatalogValuesResponse",
+    "MetricCreateInput",
+    "MetricEventRow",
+    "MetricsApiAuthError",
+    "MetricsApiError",
+    "MetricsApiRequestError",
+    "MetricsApiResponseError",
+    "RowsResponse",
+    "SyvainMetricsApiClient",
+    "cli_auth_path",
+    "load_cli_auth",
+    "normalize_metrics_host",
+]

syvain_metrics_api_client-0.0.57/src/syvain_metrics_api_client/auth.py

@@ -0,0 +1,140 @@
+from __future__ import annotations
+
+import json
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Literal, cast
+from urllib.parse import urlparse
+
+AuthMode = Literal["local", "local-dev"]
+
+DEFAULT_DEV_HOST = "https://syvain-metrics-app-dev.syvaintech.workers.dev"
+DEFAULT_PROD_HOST = "https://metrics.syvain.com"
+
+
+class MetricsApiAuthError(RuntimeError):
+    """Raised when client authentication cannot be resolved."""
+
+
+@dataclass(frozen=True)
+class ClientCredentials:
+    api_key: str
+    host: str
+    org_id: str | None = None
+    login_at: int | None = None
+    source: str = "api_key"
+
+
+def default_host_for_mode(mode: AuthMode | None = None) -> str:
+    return DEFAULT_DEV_HOST if mode == "local-dev" else DEFAULT_PROD_HOST
+
+
+def normalize_metrics_host(value: str | None, *, default_host: str) -> str:
+    raw_host = (value or "").strip() or default_host
+    parsed = urlparse(raw_host)
+    if parsed.scheme not in {"http", "https"}:
+        raise MetricsApiAuthError("Metrics API host must use http or https.")
+    if (
+        parsed.netloc == ""
+        or parsed.username is not None
+        or parsed.password is not None
+    ):
+        raise MetricsApiAuthError("Metrics API host must be a valid HTTP(S) origin.")
+    if parsed.path not in {"", "/"} or parsed.params or parsed.query or parsed.fragment:
+        raise MetricsApiAuthError(
+            "Metrics API host must not include a path, query, or fragment."
+        )
+    return f"{parsed.scheme}://{parsed.netloc}"
+
+
+def cli_auth_path(mode: AuthMode) -> Path:
+    config_home = os.environ.get("XDG_CONFIG_HOME")
+    root = Path(config_home).expanduser() if config_home else Path.home() / ".config"
+    app_name = "syvain-metrics-dev" if mode == "local-dev" else "syvain-metrics"
+    return root / app_name / "auth.json"
+
+
+def load_cli_auth(mode: AuthMode) -> ClientCredentials:
+    path = cli_auth_path(mode)
+    try:
+        raw = json.loads(path.read_text(encoding="utf-8"))
+    except FileNotFoundError as error:
+        raise MetricsApiAuthError(
+            f"Metrics CLI auth file was not found at {path}."
+        ) from error
+    except json.JSONDecodeError as error:
+        raise MetricsApiAuthError(
+            f"Metrics CLI auth file is not valid JSON: {path}."
+        ) from error
+
+    if not isinstance(raw, dict):
+        raise MetricsApiAuthError(
+            f"Metrics CLI auth file must contain a JSON object: {path}."
+        )
+
+    api_key = raw.get("apiKey")
+    if not isinstance(api_key, str) or len(api_key) == 0:
+        raise MetricsApiAuthError(
+            f"Metrics CLI auth file does not contain apiKey: {path}."
+        )
+
+    raw_host = raw.get("host")
+    host = normalize_metrics_host(
+        raw_host if isinstance(raw_host, str) else None,
+        default_host=default_host_for_mode(mode),
+    )
+
+    raw_org_id = raw.get("orgId")
+    org_id = raw_org_id if isinstance(raw_org_id, str) and raw_org_id else None
+
+    raw_login_at = raw.get("loginAt")
+    login_at = raw_login_at if isinstance(raw_login_at, int) else None
+
+    return ClientCredentials(
+        api_key=api_key,
+        host=host,
+        org_id=org_id,
+        login_at=login_at,
+        source=mode,
+    )
+
+
+def resolve_client_credentials(
+    auth: str | ClientCredentials,
+    *,
+    host: str | None = None,
+) -> ClientCredentials:
+    if isinstance(auth, ClientCredentials):
+        resolved_host = normalize_metrics_host(
+            host or auth.host, default_host=auth.host
+        )
+        return ClientCredentials(
+            api_key=auth.api_key,
+            host=resolved_host,
+            org_id=auth.org_id,
+            login_at=auth.login_at,
+            source=auth.source,
+        )
+
+    if auth in {"local", "local-dev"}:
+        mode = cast(AuthMode, auth)
+        credentials = load_cli_auth(mode)
+        if host is None:
+            return credentials
+        return ClientCredentials(
+            api_key=credentials.api_key,
+            host=normalize_metrics_host(host, default_host=credentials.host),
+            org_id=credentials.org_id,
+            login_at=credentials.login_at,
+            source=credentials.source,
+        )
+
+    api_key = auth.strip()
+    if len(api_key) == 0:
+        raise MetricsApiAuthError("Metrics API key must not be empty.")
+
+    return ClientCredentials(
+        api_key=api_key,
+        host=normalize_metrics_host(host, default_host=DEFAULT_PROD_HOST),
+    )