databay-cli 0.1.0__py3-none-any.whl

databay/resources/warehouse_principal.py

@@ -0,0 +1,51 @@
+"""``client.warehouse_principal``: the ``warehouse-principal`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from databay.operations import warehouse_principal as _ops
+from databay.resource import Resource, UNSET, Unset
+
+if TYPE_CHECKING:
+    from databay.models.warehouse_principal import PrincipalStateOut, WarehousePrincipalListProjectResponse, WarehousePrincipalListResponse
+
+
+class WarehousePrincipalResource(Resource):
+
+    def disable(
+        self,
+        *,
+        principal_id: str,
+        reason: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> PrincipalStateOut:
+        """Disable Principal. ``databay warehouse-principal disable``."""
+        return self._call(_ops.WAREHOUSE_PRINCIPAL_DISABLE, {'project_id': project_id, 'principal_id': principal_id, 'reason': reason}, project=project)
+
+    def enable(
+        self,
+        *,
+        principal_id: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> PrincipalStateOut:
+        """Enable Principal. ``databay warehouse-principal enable``."""
+        return self._call(_ops.WAREHOUSE_PRINCIPAL_ENABLE, {'project_id': project_id, 'principal_id': principal_id}, project=project)
+
+    def list(self) -> WarehousePrincipalListResponse:
+        """List Principals. ``databay warehouse-principal list``."""
+        return self._call(_ops.WAREHOUSE_PRINCIPAL_LIST, {})
+
+    def list_project(
+        self,
+        *,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> WarehousePrincipalListProjectResponse:
+        """List Project Logins. ``databay warehouse-principal list-project``."""
+        return self._call(_ops.WAREHOUSE_PRINCIPAL_LIST_PROJECT, {'project_id': project_id}, project=project)

databay/resources/warehouse_service_account.py

@@ -0,0 +1,61 @@
+"""``client.warehouse_service_account``: the ``warehouse-service-account`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from databay.operations import warehouse_service_account as _ops
+from databay.resource import Resource, UNSET, Unset
+
+if TYPE_CHECKING:
+    from databay.models.warehouse_service_account import ServiceAccountOut, WarehouseServiceAccountListResponse
+
+
+class WarehouseServiceAccountResource(Resource):
+
+    def create(
+        self,
+        *,
+        name: str,
+        role_ids: list[str],
+        project_id: str | Unset = UNSET,
+        description: str | Unset = UNSET,
+        project: str | None = None,
+        idempotency_key: str | None = None,
+    ) -> ServiceAccountOut:
+        """Create Service Account. ``databay warehouse-service-account create``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREATE, {'project_id': project_id, 'description': description, 'name': name, 'role_ids': role_ids}, project=project, idempotency_key=idempotency_key)
+
+    def delete(
+        self,
+        *,
+        service_account_id: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> None:
+        """Delete Service Account. ``databay warehouse-service-account delete``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_DELETE, {'project_id': project_id, 'service_account_id': service_account_id}, project=project)
+
+    def list(
+        self,
+        *,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> WarehouseServiceAccountListResponse:
+        """List Service Accounts. ``databay warehouse-service-account list``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_LIST, {'project_id': project_id}, project=project)
+
+    def update(
+        self,
+        *,
+        service_account_id: str,
+        project_id: str | Unset = UNSET,
+        description: str | None | Unset = UNSET,
+        name: str | None | Unset = UNSET,
+        project: str | None = None,
+    ) -> ServiceAccountOut:
+        """Update Service Account. ``databay warehouse-service-account update``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_UPDATE, {'project_id': project_id, 'service_account_id': service_account_id, 'description': description, 'name': name}, project=project)

databay/resources/warehouse_service_account_credential.py

@@ -0,0 +1,78 @@
+"""``client.warehouse_service_account_credential``: the ``warehouse-service-account-credential`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from databay.operations import warehouse_service_account_credential as _ops
+from databay.resource import Resource, UNSET, Unset
+
+if TYPE_CHECKING:
+    from databay.models.shared import IssuedLoginOut, LoginOut
+    from databay.models.warehouse_service_account_credential import WarehouseServiceAccountCredentialListResponse
+
+
+class WarehouseServiceAccountCredentialResource(Resource):
+
+    def create(
+        self,
+        *,
+        service_account_id: str,
+        db_uuid: str,
+        project_id: str | Unset = UNSET,
+        allowed_hosts: list[str] | None | Unset = UNSET,
+        valid_until: str | None | Unset = UNSET,
+        project: str | None = None,
+        idempotency_key: str | None = None,
+    ) -> IssuedLoginOut:
+        """Create Service Credential. ``databay warehouse-service-account-credential create``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_CREATE, {'project_id': project_id, 'service_account_id': service_account_id, 'allowed_hosts': allowed_hosts, 'db_uuid': db_uuid, 'valid_until': valid_until}, project=project, idempotency_key=idempotency_key)
+
+    def delete(
+        self,
+        *,
+        service_account_id: str,
+        principal_id: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> None:
+        """Delete Service Credential. ``databay warehouse-service-account-credential delete``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_DELETE, {'project_id': project_id, 'service_account_id': service_account_id, 'principal_id': principal_id}, project=project)
+
+    def list(
+        self,
+        *,
+        service_account_id: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+    ) -> WarehouseServiceAccountCredentialListResponse:
+        """List Service Credentials. ``databay warehouse-service-account-credential list``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_LIST, {'project_id': project_id, 'service_account_id': service_account_id}, project=project)
+
+    def rotate(
+        self,
+        *,
+        service_account_id: str,
+        principal_id: str,
+        project_id: str | Unset = UNSET,
+        project: str | None = None,
+        idempotency_key: str | None = None,
+    ) -> IssuedLoginOut:
+        """Rotate Service Credential. ``databay warehouse-service-account-credential rotate``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_ROTATE, {'project_id': project_id, 'service_account_id': service_account_id, 'principal_id': principal_id}, project=project, idempotency_key=idempotency_key)
+
+    def update(
+        self,
+        *,
+        service_account_id: str,
+        principal_id: str,
+        project_id: str | Unset = UNSET,
+        allowed_hosts: list[str] | None | Unset = UNSET,
+        valid_until: str | None | Unset = UNSET,
+        project: str | None = None,
+    ) -> LoginOut:
+        """Update Service Credential. ``databay warehouse-service-account-credential update``."""
+        return self._call(_ops.WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_UPDATE, {'project_id': project_id, 'service_account_id': service_account_id, 'principal_id': principal_id, 'allowed_hosts': allowed_hosts, 'valid_until': valid_until}, project=project)

databay/sdk.py

@@ -0,0 +1,77 @@
+"""
+The SDK client.
+
+::
+
+    from databay import Databay
+    from databay.tokens import EnvToken
+
+    with Databay("https://databay.example.com", EnvToken(), project="<project id>") as client:
+        pipe = client.pipe.create(source_id=..., table_name="orders", ...)
+        done = client.pipe.status(pipe_uuid=pipe.uuid, wait=True)
+
+``Databay.from_profile()`` reads the server, the token source and the active project from a CLI
+profile instead. One attribute per noun (``client.pipe``, ``client.backfill_run``) is generated in
+``databay.api``.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Self
+
+from databay.api import Api
+from databay.invoke import Session
+from databay.platform_check import ensure_supported
+from databay.transport import EventSink, Transport, no_events
+
+if TYPE_CHECKING:
+    from types import TracebackType
+
+    import httpx
+
+    from databay.tokens import TokenProvider
+
+
+class Databay(Api):
+    def __init__(
+        self,
+        server: str,
+        token: TokenProvider,
+        *,
+        project: str | None = None,
+        retries: bool = True,
+        events: EventSink = no_events,
+        http: httpx.Client | None = None,
+        profile: str | None = None,
+    ) -> None:
+        ensure_supported()
+        transport = Transport(
+            server=server.rstrip("/"), tokens=token, client_kind="sdk", retries=retries, events=events, http=http
+        )
+        super().__init__(Session(transport, active_project=project, profile=profile))
+
+    @classmethod
+    def from_profile(cls, name: str | None = None, **kwargs: object) -> Self:
+        """A client for the CLI profile ``name``, else the config's ``current_profile``."""
+        from databay.profiles import load_profile  # noqa: PLC0415
+        from databay.tokens import token_provider  # noqa: PLC0415
+
+        profile = load_profile(name)
+        return cls(
+            profile.server,
+            token_provider(profile, kwargs.get("http")),  # type: ignore[arg-type]
+            project=profile.active_project,
+            profile=profile.name,
+            **kwargs,  # type: ignore[arg-type]
+        )
+
+    def close(self) -> None:
+        self._session.transport.close()
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(
+        self, exc_type: type[BaseException] | None, exc: BaseException | None, tb: TracebackType | None
+    ) -> None:
+        self.close()

databay/settings.py

@@ -0,0 +1,90 @@
+"""
+The client's declared defaults: retries, waits, output, timeouts and where state lives.
+
+Every default the SDK or the CLI uses is declared here once, and nowhere else.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Literal
+
+OutputFormat = Literal["json", "table", "csv"]
+OUTPUT_FORMATS: tuple[OutputFormat, ...] = ("json", "table", "csv")
+
+
+@dataclass(frozen=True, slots=True)
+class RetryPolicy:
+    """
+    Retries of one request: GETs and writes sent with an ``Idempotency-Key`` only.
+
+    A retried answer is a 408, 429, 502, 503 or 504, or a connect or read failure.
+    """
+
+    max_retries: int = 3
+    #: Seconds before retry 1, 2, 3.
+    backoff_s: tuple[float, ...] = (1.0, 2.0, 4.0)
+    #: A ``Retry-After`` longer than this is cut to it.
+    retry_after_cap_s: float = 30.0
+    statuses: frozenset[int] = frozenset({408, 429, 502, 503, 504})
+
+
+@dataclass(frozen=True, slots=True)
+class WaitPolicy:
+    """How a wait polls its status operation."""
+
+    first_interval_s: float = 2.0
+    backoff: float = 1.5
+    max_interval_s: float = 15.0
+    #: Used when the wait declares no ``timeout_s`` and the caller passes no ``--timeout``.
+    default_timeout_s: float = 600.0
+    #: ``pipe wait --until data`` without ``--timeout``: one 15-minute freshness-probe cycle plus slack.
+    data_timeout_s: float = 1200.0
+    #: Past the limit, a tick's later requests still go out for this long, so the last tick, which
+    #: starts at the limit after its pause, can finish when the server answers normally.
+    tick_grace_s: float = 5.0
+    #: Transient failures (5xx, 408, 429, network) in a row that end a wait with that failure.
+    max_transient_in_a_row: int = 3
+
+
+@dataclass(frozen=True, slots=True)
+class ClientSettings:
+    retry: RetryPolicy = RetryPolicy()
+    wait: WaitPolicy = WaitPolicy()
+    #: Connect timeout and read timeout of one request, in seconds.
+    connect_timeout_s: float = 10.0
+    read_timeout_s: float = 60.0
+    #: How long a server's ``/api/auth/client-config`` answer is reused before it is read again.
+    client_config_ttl_s: float = 3600.0
+    #: An access token with this many seconds of validity left or fewer is renewed before it is sent.
+    refresh_margin_s: float = 60.0
+    #: How long ``databay login`` waits for the browser to come back to the loopback callback.
+    browser_login_timeout_s: float = 300.0
+    #: How often the update notice asks PyPI for the newest release, and how long that request may take.
+    update_check_interval_s: float = 86400.0
+    update_check_timeout_s: float = 2.0
+
+
+SETTINGS = ClientSettings()
+
+#: The profile ``databay login`` writes when no ``--profile`` is passed.
+DEFAULT_PROFILE = "default"
+#: Where ``databay login`` keeps tokens unless ``--token-store`` says otherwise.
+DEFAULT_TOKEN_STORE = "keyring"  # noqa: S105 — the store's name, not a secret
+#: Where ``databay skill install`` puts the skill unless ``--scope`` says otherwise: the user's home.
+DEFAULT_SKILL_SCOPE = "user"
+
+#: Environment variables the client reads. Each is an explicit input, documented in ``--help``.
+ENV_TOKEN = "DATABAY_TOKEN"  # noqa: S105 — the variable's name, not a token
+ENV_OUTPUT = "DATABAY_OUTPUT"
+ENV_CONFIG_DIR = "DATABAY_CONFIG_DIR"
+ENV_STATE_DIR = "DATABAY_STATE_DIR"
+ENV_NO_COLOR = "NO_COLOR"
+ENV_NO_UPDATE_CHECK = "DATABAY_NO_UPDATE_CHECK"
+#: Set by CI systems; the update notice stays off under it.
+ENV_CI = "CI"
+
+OUTPUT_RULE = (
+    "Output: a table when stdout is a terminal, JSON otherwise. --output json|table|csv, "
+    f"or {ENV_OUTPUT}, picks one; --output wins over {ENV_OUTPUT}."
+)