databay-cli 0.1.0__py3-none-any.whl

databay/operations/warehouse_service_account.py

@@ -0,0 +1,206 @@
+"""The ``warehouse-service-account`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_SERVICE_ACCOUNT_CREATE = Operation(
+    operation_id='warehouse_service_account_create',
+    noun='warehouse-service-account',
+    verb='create',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts',
+    summary='Create Service Account',
+    description='Create a service account with at least one access role (422 ``service_account_needs_access_role``).',
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='ServiceAccountCreate',
+        fields=(
+            Param(
+                name='description',
+                location='body',
+                kind='string',
+                required=False,
+                description='Description',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Name',
+            ),
+            Param(
+                name='role_ids',
+                location='body',
+                kind='list',
+                required=True,
+                description="the account's access roles; at least one",
+                item_kind='string',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_service_account:ServiceAccountOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-service-account create <project_id> --file service-account.json',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_DELETE = Operation(
+    operation_id='warehouse_service_account_delete',
+    noun='warehouse-service-account',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}',
+    summary='Delete Service Account',
+    description='Delete the account and every credential it holds.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay warehouse-service-account delete <project_id> <service_account_id> --yes',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_LIST = Operation(
+    operation_id='warehouse_service_account_list',
+    noun='warehouse-service-account',
+    verb='list',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts',
+    summary='List Service Accounts',
+    description="List the project's service accounts.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_service_account:WarehouseServiceAccountListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-service-account list <project_id>',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'role_ids',
+        'credentials',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_UPDATE = Operation(
+    operation_id='warehouse_service_account_update',
+    noun='warehouse-service-account',
+    verb='update',
+    method='patch',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}',
+    summary='Update Service Account',
+    description='Rename or redescribe the account.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+    ),
+    body=Body(
+        schema='ServiceAccountPatch',
+        fields=(
+            Param(
+                name='description',
+                location='body',
+                kind='string',
+                required=False,
+                description='Description',
+                nullable=True,
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Name',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='warehouse_service_account:ServiceAccountOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-service-account update <project_id> <service_account_id> --name reporting',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_SERVICE_ACCOUNT_CREATE,
+    WAREHOUSE_SERVICE_ACCOUNT_DELETE,
+    WAREHOUSE_SERVICE_ACCOUNT_LIST,
+    WAREHOUSE_SERVICE_ACCOUNT_UPDATE,
+)

databay/operations/warehouse_service_account_credential.py

@@ -0,0 +1,285 @@
+"""The ``warehouse-service-account-credential`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_CREATE = Operation(
+    operation_id='warehouse_service_account_credential_create',
+    noun='warehouse-service-account-credential',
+    verb='create',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}/credentials',
+    summary='Create Service Credential',
+    description="Create the account's credential for one warehouse its roles read, and return its password, once.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+    ),
+    body=Body(
+        schema='LoginCreate',
+        fields=(
+            Param(
+                name='allowed_hosts',
+                location='body',
+                kind='list',
+                required=False,
+                description='IP addresses or networks; null: any',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='db_uuid',
+                location='body',
+                kind='string',
+                required=True,
+                description='Db Uuid',
+            ),
+            Param(
+                name='valid_until',
+                location='body',
+                kind='string',
+                required=False,
+                description='null: the login does not expire',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:IssuedLoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-service-account-credential create <project_id> <service_account_id> --db-uuid <db_uuid>',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_DELETE = Operation(
+    operation_id='warehouse_service_account_credential_delete',
+    noun='warehouse-service-account-credential',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}/credentials/{principal_id}',
+    summary='Delete Service Credential',
+    description='Delete the credential; the warehouse drops it at the next reconcile.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+        Param(
+            name='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay warehouse-service-account-credential delete <project_id> <service_account_id> <principal_id> --yes',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_LIST = Operation(
+    operation_id='warehouse_service_account_credential_list',
+    noun='warehouse-service-account-credential',
+    verb='list',
+    method='get',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}/credentials',
+    summary='List Service Credentials',
+    description="List the account's credentials, one per warehouse.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='warehouse_service_account_credential:WarehouseServiceAccountCredentialListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay warehouse-service-account-credential list <project_id> <service_account_id>',
+    ),
+    columns=(
+        'principal_id',
+        'warehouse_name',
+        'native_username',
+        'state',
+        'valid_until',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_ROTATE = Operation(
+    operation_id='warehouse_service_account_credential_rotate',
+    noun='warehouse-service-account-credential',
+    verb='rotate',
+    method='post',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}/credentials/{principal_id}/rotate',
+    summary='Rotate Service Credential',
+    description='Issue a new password, shown once.',
+    project='path:project_id',
+    destructive=True,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+        Param(
+            name='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:IssuedLoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-service-account-credential rotate <project_id> <service_account_id> <principal_id> --yes',
+    ),
+)
+
+WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_UPDATE = Operation(
+    operation_id='warehouse_service_account_credential_update',
+    noun='warehouse-service-account-credential',
+    verb='update',
+    method='patch',
+    path='/api/configstore/projects/{project_id}/warehouse-access/service-accounts/{service_account_id}/credentials/{principal_id}',
+    summary='Update Service Credential',
+    description="Change the credential's expiry or allowed hosts; ``null`` clears one.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='service_account_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Service Account Id',
+        ),
+        Param(
+            name='principal_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Principal Id',
+        ),
+    ),
+    body=Body(
+        schema='LoginPatch',
+        fields=(
+            Param(
+                name='allowed_hosts',
+                location='body',
+                kind='list',
+                required=False,
+                description='Allowed Hosts',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='valid_until',
+                location='body',
+                kind='string',
+                required=False,
+                description='Valid Until',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:LoginOut',
+        shape='object',
+    ),
+    examples=(
+        'databay warehouse-service-account-credential update <project_id> <service_account_id> <principal_id> --file credential.json',
+    ),
+)
+
+OPERATIONS = (
+    WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_CREATE,
+    WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_DELETE,
+    WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_LIST,
+    WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_ROTATE,
+    WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_UPDATE,
+)

databay/paths.py

@@ -0,0 +1,32 @@
+"""Where the client keeps its config and its state."""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+from databay.settings import ENV_CONFIG_DIR, ENV_STATE_DIR
+
+
+def config_dir() -> Path:
+    """``$DATABAY_CONFIG_DIR`` when set, else the platform's config dir (``$XDG_CONFIG_HOME/databay`` on Linux)."""
+    explicit = os.environ.get(ENV_CONFIG_DIR)
+    if explicit:
+        return Path(explicit)
+    import platformdirs  # noqa: PLC0415
+
+    return Path(platformdirs.user_config_dir("databay", appauthor=False))
+
+
+def state_dir() -> Path:
+    """``$DATABAY_STATE_DIR`` when set, else the platform's state dir (``~/.local/state/databay`` on Linux)."""
+    explicit = os.environ.get(ENV_STATE_DIR)
+    if explicit:
+        return Path(explicit)
+    import platformdirs  # noqa: PLC0415
+
+    return Path(platformdirs.user_state_dir("databay", appauthor=False))
+
+
+def config_file() -> Path:
+    return config_dir() / "config.toml"

databay/platform_check.py

@@ -0,0 +1,20 @@
+"""The client runs on Linux and macOS; anything else stops with ``unsupported_platform``."""
+
+from __future__ import annotations
+
+import sys
+
+from databay.errors import DatabayUsageError
+
+SUPPORTED_PLATFORMS = ("linux", "darwin")
+
+
+def ensure_supported(platform: str = sys.platform) -> None:
+    if platform.startswith(SUPPORTED_PLATFORMS):
+        return
+    hint = "Use WSL on Windows." if platform in {"win32", "cygwin"} else "Use Linux or macOS."
+    raise DatabayUsageError(
+        f"databay runs on Linux and macOS, not {platform}. {hint}",
+        code="unsupported_platform",
+        details={"platform": platform},
+    )