k9o 1.0.0__py3-none-any.whl

k9o/__init__.py

@@ -0,0 +1,143 @@
+"""
+k9o — Kilimanjaro platform SDK (Python; idiomatic).
+
+Canonical usage:
+
+    from k9o import create_client, KError
+
+    k9o = create_client(
+        base_url="https://acme.api.k9o.io",
+        api_key=os.environ["K9O_API_KEY"],
+        org_slug="acme",
+        project_slug="member-portal",
+    )
+
+    try:
+        response = k9o.from_("posts").select().limit(10).execute()
+        for row in response.data:
+            print(row)
+        session = k9o.gate.sign_in(email="user@example.com", password="…")
+        print("signed in:", session.data["user"]["id"])
+    except KError as e:
+        print(f"[{e.code}] {e.message}: {e.recommendation}")
+
+Architectural posture: hand-authored idiomatic SDK against the platform API specification
++ services/gateway/openapi.json contract source; replaces the prior
+OpenAPI-generator output (`k9o_gate` raw client) with ch13 idiomatic
+shape (snake_case methods + raise KError + envelope dataclass with
+typed meta accessor sugar + data DSL).
+"""
+
+from __future__ import annotations
+
+from .audit import AuditNamespace
+from .client import K9oClient, create_client
+from .compute import ComputeNamespace, LlmsNamespace, LLM_MODEL_IDS, LLM_ERROR_CODES
+from .data import FromBuilder, SelectBuilder, UpdateBuilder, DeleteBuilder
+from .functions import FunctionsNamespace
+from .kibo_vault import KiboNamespace, SecretsNamespace, VaultNamespace
+from .me import MeNamespace
+from .migrations import MigrationsNamespace
+from .org import OrgNamespace
+from .orgs import OrgsNamespace
+from .policies import PoliciesNamespace
+from .realtime import RealtimeNamespace, realtime_topic, REALTIME_TOPIC_FAMILIES
+from .studio import (
+    StudioNamespace,
+    WorkflowsNamespace,
+    DashboardsNamespace,
+    WORKFLOW_ERROR_CODES,
+    DASHBOARD_ERROR_CODES,
+    WORKFLOW_TRIGGER_TYPES,
+    WORKFLOW_ACTION_TYPES,
+    WIDGET_TYPES,
+)
+from .envelope import (
+    Envelope,
+    Meta,
+    MetaContext,
+    MetaCursor,
+    MetaIdempotency,
+    MetaSubscription,
+    MetaTiming,
+    MetaWarning,
+)
+from .errors import KError, KErrorWire, kerror_from_wire
+from .gate import GateNamespace
+from .http import HttpClientConfig, RetryConfig
+from .projects import Project, ProjectsNamespace
+from .url_grammar import (
+    org_path,
+    platform_path,
+    project_path,
+    resolve_base_url,
+    validate_base_url,
+    validate_slug,
+)
+
+__version__ = "0.3.0"
+
+__all__ = [
+    "__version__",
+    # Factory + client
+    "create_client",
+    "K9oClient",
+    # Error
+    "KError",
+    "KErrorWire",
+    "kerror_from_wire",
+    # Envelope + meta
+    "Envelope",
+    "Meta",
+    "MetaContext",
+    "MetaCursor",
+    "MetaIdempotency",
+    "MetaSubscription",
+    "MetaTiming",
+    "MetaWarning",
+    # Data DSL
+    "FromBuilder",
+    "SelectBuilder",
+    "UpdateBuilder",
+    "DeleteBuilder",
+    # Namespaces
+    "ProjectsNamespace",
+    "Project",
+    "GateNamespace",
+    "StudioNamespace",
+    "WorkflowsNamespace",
+    "DashboardsNamespace",
+    "ComputeNamespace",
+    "LlmsNamespace",
+    "RealtimeNamespace",
+    "realtime_topic",
+    "OrgNamespace",
+    "OrgsNamespace",
+    "MigrationsNamespace",
+    "FunctionsNamespace",
+    "PoliciesNamespace",
+    "AuditNamespace",
+    "MeNamespace",
+    "KiboNamespace",
+    "VaultNamespace",
+    "SecretsNamespace",
+    # P6 closed enums + error-code maps
+    "WORKFLOW_ERROR_CODES",
+    "DASHBOARD_ERROR_CODES",
+    "LLM_ERROR_CODES",
+    "WORKFLOW_TRIGGER_TYPES",
+    "WORKFLOW_ACTION_TYPES",
+    "WIDGET_TYPES",
+    "LLM_MODEL_IDS",
+    "REALTIME_TOPIC_FAMILIES",
+    # URL grammar
+    "validate_base_url",
+    "resolve_base_url",
+    "validate_slug",
+    "project_path",
+    "org_path",
+    "platform_path",
+    # HTTP config (advanced use)
+    "HttpClientConfig",
+    "RetryConfig",
+]

k9o/ai.py

@@ -0,0 +1,45 @@
+"""
+AI namespace — `client.ai.*` (platform AI primitives).
+
+Wire mapping (project-plane):
+  - embed(input, model=None) -> POST /@<slug>/ai/embeddings
+        body {model?, input: str | list[str]}
+        -> Envelope(data={"embeddings": [[float, ...], ...], "model": str, "dimensions": int})
+
+Bounds (non-empty inputs, count, size, concurrency) are enforced by the
+gateway, not here. The SDK sends `input` exactly as given and never puts it
+in an error it constructs.
+"""
+
+from __future__ import annotations
+
+from typing import Sequence
+
+from .envelope import Envelope
+from .http import HttpClientConfig, request
+from .url_grammar import project_path
+
+
+def _require_project_slug(config: HttpClientConfig) -> str:
+    if not config.project_slug:
+        raise ValueError("ai operations require project_slug bound on the client")
+    return config.project_slug
+
+
+class AiNamespace:
+    """`client.ai.*`."""
+
+    def __init__(self, config: HttpClientConfig) -> None:
+        self._config = config
+
+    def embed(self, input: str | Sequence[str], *, model: str | None = None) -> Envelope:
+        """POST /@<slug>/ai/embeddings — embed one string or a list of strings.
+
+        `model` is omitted from the body when None (server default). A single
+        string stays a string; a sequence is sent as a list, in order.
+        """
+        slug = _require_project_slug(self._config)
+        body: dict = {"input": input if isinstance(input, str) else list(input)}
+        if model is not None:
+            body["model"] = model
+        return request(self._config, method="POST", path=project_path(slug, "ai/embeddings"), body=body)

k9o/audit.py

@@ -0,0 +1,48 @@
+"""
+Project-plane audit log namespace — `client.audit.*`.
+
+Distinct from `client.org.audit_log` (org-plane) and
+`client.me.audit_log` (operator-self). Python idiomatic per ch13 §2.1.1.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime, timedelta, timezone
+from typing import Any
+from urllib.parse import quote
+
+from .envelope import Envelope
+from .http import HttpClientConfig, request
+from .url_grammar import project_path
+
+
+def _require_project_slug(config: HttpClientConfig) -> str:
+    if not config.project_slug:
+        raise ValueError("audit operations require project_slug bound on the client")
+    return config.project_slug
+
+
+def _clean(d: dict[str, Any]) -> dict[str, Any]:
+    return {k: v for k, v in d.items() if v is not None}
+
+
+class AuditNamespace:
+    def __init__(self, config: HttpClientConfig) -> None:
+        self._config = config
+
+    def query(self, *, since: str | None = None, until: str | None = None, type: str | None = None,
+              actor_id: str | None = None, target_kind: str | None = None, target_id: str | None = None,
+              limit: int | None = None, cursor: str | None = None) -> Envelope:
+        """Query the audit log (reverse-chronological; filters AND-compose)."""
+        slug = _require_project_slug(self._config)
+        return request(self._config, method="GET", path=project_path(slug, "audit-log"),
+                       query=_clean({"since": since, "until": until, "type": type, "actorId": actor_id,
+                                     "targetKind": target_kind, "targetId": target_id,
+                                     "limit": limit, "cursor": cursor}))
+
+    def tail(self, *, since_minutes: int = 1, limit: int = 100) -> Envelope:
+        """Convenience: recent events within a since-window."""
+        slug = _require_project_slug(self._config)
+        since = (datetime.now(timezone.utc) - timedelta(minutes=since_minutes)).isoformat()
+        return request(self._config, method="GET", path=project_path(slug, "audit-log"),
+                       query={"since": since, "limit": limit})

k9o/barbican/__init__.py

@@ -0,0 +1,20 @@
+"""``k9o.barbican`` — free, embeddable L2 Keep guardrail (Python).
+
+Unicode-normalize -> Aho-Corasick deny over a signed ruleset -> buffer-and-
+scan output stream-filter. A thin wrapper over the audited ``k9o-keep-core``
+engine, compiled to a native lib via uniffi (mirrors the ``k9o.kibo`` crypto
+wrapper's FFI shape). ZERO security logic here: every normalization pass,
+deny match, verdict, and output redaction is the core's; this layer only
+forwards typed calls to the generated binding and maps its error -> ``KError``.
+
+CLAIM BOUNDARY (security-claims-non-negotiable): Barbican is advisory /
+defense-in-depth (Edge Filtration). "Un-bypassable" attaches ONLY to the
+Enforced Boundary (Warden as the sole sandbox egress) -- never this SDK.
+
+The native lib + generated uniffi binding under ``_ffi/`` are build artifacts
+(generated per platform; gitignored) -- same convention as ``k9o.kibo``.
+"""
+
+from .barbican import Barbican, OutputFilter
+
+__all__ = ["Barbican", "OutputFilter"]

k9o/barbican/_ffi/__init__.py

@@ -0,0 +1,5 @@
+# Generated uniffi binding + native lib live here (build artifacts, gitignored).
+# Regenerate: cargo build -p k9o-keep-core-ffi-uniffi --release --features cli
+#   + cargo run --bin uniffi-bindgen --features cli -- generate \
+#       --library target/release/libk9o_keep_core_ffi_uniffi.dylib \
+#       --language python --out-dir .

k9o/barbican/barbican.py

@@ -0,0 +1,218 @@
+"""Thin wrapper over the bound ``k9o-keep-core`` engine (native, via uniffi).
+
+Sync throughout -- the core has no async fn (unlike ``k9o.kibo``'s crypto,
+which calls a network KMS), and the rest of the ``k9o`` Python SDK is sync
+(``requests``/``httpx``-style), so there is no async-for-future-proofing need
+here the way there is in the TS SDK (JS network calls force async; Python
+doesn't have that constraint -- a future hosted-tier escalation can stay sync).
+"""
+
+from __future__ import annotations
+
+import time
+from typing import Any
+
+from ..errors import KError
+from ._ffi import k9o_keep_core_ffi_uniffi as _ffi
+
+
+def _map_error(e: Exception, stage: str = "ruleset") -> KError:
+    """Map the bound core's ``KeepError`` -> ``KError``. ``KeepError.RulesetInvalid``
+    is the only variant today (a refused ruleset, manifest or key manifest); the
+    core's closed reason token (``unknown_kid`` / ``signature_invalid`` /
+    ``signature_non_canonical`` / ``version_stale`` / ``malformed`` / ... or an
+    unknown-severity message) rides in ``context.reason``, and ``context.stage``
+    says whether it came from the ruleset or the key manifest.
+    """
+    reason = getattr(e, "reason", None)
+    if reason is not None:
+        return KError(
+            code="K9O_BARBICAN_RULESET_INVALID",
+            message=str(e),
+            context={"reason": reason, "stage": stage},
+        )
+    return KError(code="K9O_BARBICAN_WASM_ERROR", message=str(e))
+
+
+class OutputFilter:
+    """A streaming output redactor. Buffer-and-scan-before-flush: never emits a
+    byte the core has not cleared (no RST-after-leak)."""
+
+    def __init__(self, handle: Any) -> None:
+        self._handle = handle
+
+    def push(self, chunk: str) -> str:
+        """Feed a chunk; returns the cleared (redacted) prefix safe to emit now."""
+        return self._handle.push(chunk)
+
+    def finish(self) -> str:
+        """Flush the residual buffer (also scanned) at end of stream."""
+        return self._handle.finish()
+
+    def report(self) -> Any:
+        """Leak report (counts only -- never the leaked values): an object with
+        ``emails``, ``secrets``, ``markers``, ``total``."""
+        return self._handle.report()
+
+
+class Barbican:
+    """The free, embeddable L2 guardrail. See the package docstring for the
+    claim boundary."""
+
+    def __init__(
+        self,
+        *,
+        fail_open: bool = False,
+        leet: bool = True,
+        decode_depth: int = 0,
+    ) -> None:
+        """``decode_depth`` of 0 uses the core default (3) -- a bounded base64/
+        leetspeak de-obfuscation depth (decode-bomb guard)."""
+        self._core = _ffi.KeepCore(
+            _ffi.KeepConfig(fail_open=fail_open, leet=leet, decode_depth=decode_depth)
+        )
+
+    def load_ruleset(self, ruleset_version: int, rules: list[dict[str, str]]) -> int:
+        """Load a static ruleset bundled with your package (Mode-A path: provenance
+        is vouched for by your package, so signature verification is skipped --
+        the core still enforces anti-rollback, never loading a version <= the
+        current one). ``rules`` = ``[{"id", "pattern", "severity"}]``
+        (severity one of low|medium|high|critical). Returns the accepted version.
+        """
+        blob = _ffi.KeepRulesetBlob(
+            ruleset_version=ruleset_version,
+            rules=[
+                _ffi.KeepRule(id=r["id"], pattern=r["pattern"], severity=r["severity"])
+                for r in rules
+            ],
+        )
+        try:
+            return self._core.load_ruleset_unsigned(blob)
+        except _ffi.KeepError as e:  # type: ignore[attr-defined]
+            raise _map_error(e) from e
+
+    def load_key_manifest(self, jws: str, now_secs: int | None = None) -> int:
+        """Load a Barbican key manifest (compact JWS, ``typ k9o.barbican.keys.v1``).
+        The core checks it against the root key compiled into it and, only if it
+        verifies, REPLACES the trusted ruleset-signing keys with the ones it lists.
+        A refusal (wrong signer, rollback, a key changing its public key, a
+        malformed entry) raises ``K9O_BARBICAN_RULESET_INVALID`` with
+        ``context.stage == "key_manifest"`` and leaves the trusted keys unchanged.
+        Returns the manifest ``sequence``."""
+        try:
+            return self._core.load_key_manifest(
+                jws, int(time.time()) if now_secs is None else now_secs
+            )
+        except _ffi.KeepError as e:  # type: ignore[attr-defined]
+            raise _map_error(e, "key_manifest") from e
+
+    def verify_manifest(self, jws: str) -> Any:
+        """Verify a ruleset manifest (compact JWS) under a trusted key and return
+        its authenticated fields (``ruleset_version``, ``signing_key_kid``,
+        ``artifact_hash``, ``artifact_url``, ``valid_until``)."""
+        try:
+            return self._core.verify_manifest(jws)
+        except _ffi.KeepError as e:  # type: ignore[attr-defined]
+            raise _map_error(e) from e
+
+    def load_ruleset_signed(
+        self,
+        ruleset_version: int,
+        rules: list[dict[str, str]],
+        signing_key_kid: str,
+        signature: bytes,
+        created_at: int = 0,
+    ) -> int:
+        """Load a signed ruleset. The core verifies the Ed25519 signature ITSELF,
+        over its own canonical bytes, under a key from the loaded key manifest:
+        there is no key or verifier to pass. Any failure (no key manifest loaded,
+        unknown key, bad or non-canonical signature, stale version, malformed
+        rules) raises ``K9O_BARBICAN_RULESET_INVALID`` with ``context.reason`` and
+        leaves the current ruleset running. Returns the accepted version."""
+        try:
+            return self._core.load_ruleset_signed(self._signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at))
+        except _ffi.KeepError as e:  # type: ignore[attr-defined]
+            raise _map_error(e) from e
+
+    def ruleset_digest(
+        self,
+        ruleset_version: int,
+        rules: list[dict[str, str]],
+        signing_key_kid: str,
+        signature: bytes,
+        created_at: int = 0,
+    ) -> str:
+        """Lowercase hex SHA-256 of a ruleset's canonical signing bytes -- the value
+        a manifest's ``artifact_hash`` names. A digest only; it decides no trust."""
+        try:
+            return self._core.ruleset_digest(self._signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at))
+        except _ffi.KeepError as e:  # type: ignore[attr-defined]
+            raise _map_error(e) from e
+
+    @staticmethod
+    def _signed_blob(ruleset_version, rules, signing_key_kid, signature, created_at) -> Any:
+        return _ffi.KeepSignedRulesetBlob(
+            ruleset_version=ruleset_version,
+            rules=[
+                _ffi.KeepRule(id=r["id"], pattern=r["pattern"], severity=r["severity"])
+                for r in rules
+            ],
+            signing_key_kid=signing_key_kid,
+            signature=bytes(signature),
+            created_at=created_at,
+        )
+
+    @property
+    def key_manifest_sequence(self) -> int:
+        """The ``sequence`` of the key manifest in force (0 before one is loaded)."""
+        return self._core.key_manifest_sequence()
+
+    @property
+    def signed_floor(self) -> int:
+        """The highest VERIFIED ruleset version loaded (0 = none): the anti-rollback floor for signed
+        updates. A refresh compares a published version against this, not the version in force."""
+        return self._core.signed_floor()
+
+    @property
+    def active_ruleset_is_signed(self) -> bool:
+        """Whether the ruleset in force came from a verified load. False when none is loaded, or when
+        ``load_ruleset`` (unsigned, host-vouched) replaced a verified one."""
+        return self._core.active_ruleset_is_signed()
+
+    def trusted_kids(self) -> list[str]:
+        """The signing ``kid`` s the loaded key manifest currently trusts, sorted."""
+        return self._core.trusted_kids()
+
+    def deprecated_kids(self) -> list[str]:
+        """The trusted ``kid`` s the key manifest flags ``deprecated``, sorted."""
+        return self._core.deprecated_kids()
+
+    @staticmethod
+    def uses_test_trust_root() -> bool:
+        """``False`` on every shipped build. ``True`` means this binding trusts the
+        PUBLISHED TEST root and must never be used outside tests."""
+        return _ffi.uses_test_trust_root()
+
+    def inspect(self, text: str, *, waypoint_class: str | None = None) -> Any:
+        """Inspect an input (normalize -> deny -> local verdict). Obfuscation is
+        peeled BEFORE matching, so static deny-lists aren't defeated by trivial
+        tricks. ``waypoint_class`` is the manifest's meter hint -- it NEVER gates
+        the decision. Returns the verdict object (``decision``, ``reason``,
+        ``matched``, ``schema_valid``, ``waypoint_class_hint``, ``fail_mode``,
+        ``ruleset_version``, ``core_version``)."""
+        return self._core.inspect_input(text, waypoint_class)
+
+    def classify(self, text: str) -> str:
+        """Local L3 stand-in classification (``"clear"|"suspicious"|"malicious"``).
+        No receipt -- a classification is not an enforcement decision."""
+        return self._core.classify_local(text)
+
+    def create_output_filter(self) -> OutputFilter:
+        """Open an output stream-filter bound to the active ruleset's exfil
+        markers."""
+        return OutputFilter(self._core.output_filter())
+
+    @property
+    def core_version(self) -> str:
+        """The bound core's semver (audit anchor; rides every verdict too)."""
+        return self._core.core_version()

k9o/client.py

@@ -0,0 +1,132 @@
+"""
+`create_client(...)` factory + `K9oClient`.
+
+Canonical usage:
+
+    from k9o import create_client, KError
+
+    k9o = create_client(
+        base_url="https://acme.api.k9o.io",
+        api_key=os.environ["K9O_API_KEY"],
+        org_slug="acme",
+        project_slug="member-portal",
+    )
+
+    try:
+        response = k9o.from_("posts").select().limit(10).execute()
+        for row in response.data:
+            print(row)
+        if response.meta.cursor:
+            print("next cursor:", response.meta.cursor.next)
+    except KError as e:
+        print(f"[{e.code}] {e.message}: {e.recommendation}")
+        raise
+"""
+
+from __future__ import annotations
+
+from .ai import AiNamespace
+from .audit import AuditNamespace
+from .compute import ComputeNamespace
+from .data import FromBuilder
+from .functions import FunctionsNamespace
+from .gate import GateNamespace
+from .http import HttpClientConfig, RetryConfig
+from .kibo_vault import KiboNamespace
+from .me import MeNamespace
+from .migrations import MigrationsNamespace
+from .org import OrgNamespace
+from .orgs import OrgsNamespace
+from .policies import PoliciesNamespace
+from .projects import ProjectsNamespace
+from .realtime import RealtimeNamespace
+from .storage import StorageNamespace
+from .studio import StudioNamespace
+from .url_grammar import resolve_base_url
+
+
+class K9oClient:
+    """The client returned by `create_client(...)`.
+
+    Namespaces hang off the instance — composed from per-resource
+    factories sharing the bound HTTP config.
+
+    Attributes:
+      projects  — `client.projects.list()` / `.create(...)` / `.get(slug)` / `.update(slug, ...)`
+      gate      — `client.gate.sign_in(...)` / `.sign_up(...)` / `.whoami()` / etc. (requires project_slug)
+      kibo      — `client.kibo.vault.secrets.{list,get,create,reveal_challenge,reveal,update,rotate,move,delete}`
+                  (ZK vault-secrets surface, ch08 §14; requires project_slug)
+      storage   — `client.storage.{create_bucket,get_bucket,list_buckets,update_bucket,delete_bucket}` and
+                  `client.storage.from_(bucket).{upload,create_signed_url,list,remove}` (each with an `_async`
+                  twin; requires project_slug)
+
+    Methods:
+      from_(collection) — data-plane DSL; returns a FromBuilder
+    """
+
+    def __init__(self, config: HttpClientConfig) -> None:
+        self._config = config
+        self.projects = ProjectsNamespace(config)
+        self.gate = GateNamespace(config)
+        self.migrations = MigrationsNamespace(config)
+        self.functions = FunctionsNamespace(config)
+        self.policies = PoliciesNamespace(config)
+        self.audit = AuditNamespace(config)
+        self.orgs = OrgsNamespace(config)
+        self.me = MeNamespace(config)
+        self.studio = StudioNamespace(config)
+        self.compute = ComputeNamespace(config)
+        self.ai = AiNamespace(config)
+        self.realtime = RealtimeNamespace(config)
+        self.org = OrgNamespace(config)
+        self.kibo = KiboNamespace(config)
+        self.storage = StorageNamespace(config)
+
+    @property
+    def config(self) -> HttpClientConfig:
+        """Bound config (read-only access for advanced use)."""
+        return self._config
+
+    def from_(self, collection: str) -> FromBuilder:
+        """Data-plane DSL entry point. `from` is a Python keyword so we use `from_`."""
+        return FromBuilder(self._config, collection)
+
+
+def create_client(
+    *,
+    base_url: str | None = None,
+    api_key: str | None = None,
+    org_slug: str | None = None,
+    project_slug: str | None = None,
+    default_headers: dict[str, str] | None = None,
+    retry_config: RetryConfig | None = None,
+) -> K9oClient:
+    """Construct a K9oClient bound to the supplied gateway baseUrl + auth + context.
+
+    base_url is OPTIONAL (ch13 §7.1): when omitted it defaults to the platform
+    apex 'https://api.k9o.io'; when the host is the bare apex and org_slug is
+    set, the SDK derives the canonical org-subdomain root
+    'https://<orgSlug>.api.k9o.io'. Any other host (explicit subdomain,
+    self-hosted, dev) is used unchanged. Validates baseUrl at construct time
+    per ch13 §7.2 — path-bearing URLs raise KError(K9O_INVALID_BASE_URL).
+
+    Args:
+      base_url: optional scheme + host (e.g. 'https://acme.api.k9o.io' or
+        'https://api.k9o.io'); defaults to 'https://api.k9o.io'
+      api_key: bearer token for default auth (per-call override is supported)
+      org_slug: active org context; sent as 'x-k9o-org-slug' header
+      project_slug: active project context; sent as 'x-k9o-project-slug' header
+      default_headers: headers merged into every request
+      retry_config: retry/backoff policy (ch13 §7.1); None ⇒ defaults
+        (3 retries, exponential) on idempotent methods + transient failures
+    """
+    resolved = resolve_base_url(base_url, org_slug)
+    config = HttpClientConfig(
+        base_url=resolved,
+        api_key=api_key,
+        org_slug=org_slug,
+        project_slug=project_slug,
+        default_headers=dict(default_headers or {}),
+        retry_config=retry_config,
+    )
+    return K9oClient(config)