deepctl-cmd-keys 0.0.2__tar.gz

deepctl_cmd_keys-0.0.2/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: deepctl-cmd-keys
+Version: 0.0.2
+Summary: API keys management command for deepctl
+Author-email: Deepgram <devrel@deepgram.com>
+Maintainer-email: Deepgram <devrel@deepgram.com>
+License-Expression: MIT
+Keywords: deepgram,cli,keys,api-keys
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: deepctl-core>=0.1.10
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pydantic>=2.0.0
+
+# deepctl-cmd-keys
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+API keys management command for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl keys` | `deepctl_cmd_keys.command:KeysCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+- `pydantic>=2.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_cmd_keys-0.0.2/README.md

@@ -0,0 +1,42 @@
+# deepctl-cmd-keys
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+API keys management command for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl keys` | `deepctl_cmd_keys.command:KeysCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+- `pydantic>=2.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_cmd_keys-0.0.2/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "deepctl-cmd-keys"
+version = "0.0.2" # x-release-please-version
+description = "API keys management command for deepctl"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "Deepgram", email = "devrel@deepgram.com" }]
+maintainers = [{ name = "Deepgram", email = "devrel@deepgram.com" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["deepgram", "cli", "keys", "api-keys"]
+requires-python = ">=3.10"
+dependencies = [
+    "deepctl-core>=0.1.10",
+    "click>=8.0.0",
+    "rich>=13.0.0",
+    "pydantic>=2.0.0",
+]
+
+[project.scripts]
+
+[project.entry-points."deepctl.commands"]
+keys = "deepctl_cmd_keys.command:KeysCommand"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["deepctl_cmd_keys*"]

deepctl_cmd_keys-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys/__init__.py

@@ -0,0 +1 @@
+"""API keys management command for deepctl."""

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys/command.py

@@ -0,0 +1,296 @@
+"""API keys management command for deepctl."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from deepctl_core import (
+    AuthManager,
+    BaseCommand,
+    BaseResult,
+    Config,
+    DeepgramClient,
+)
+from rich.console import Console
+from rich.table import Table
+
+from .models import KeyCreatedInfo, KeyInfo, KeysResult
+
+console = Console()
+
+
+class KeysCommand(BaseCommand):
+    """Command for managing Deepgram API keys."""
+
+    name = "keys"
+    help = "Manage Deepgram API keys"
+    short_help = "Manage API keys"
+
+    requires_auth = True
+    requires_project = True
+    ci_friendly = True
+
+    examples = [
+        "dg keys",
+        "dg keys --list",
+        "dg keys --create --comment 'staging key' --scopes member",
+        "dg keys --show KEY_ID",
+        "dg keys --delete KEY_ID",
+        "dg keys --list --status active",
+    ]
+    agent_help = (
+        "Manage Deepgram API keys for the current project. "
+        "List, create, show, and delete API keys. "
+        "Requires authentication and a project ID."
+    )
+
+    def get_arguments(self) -> list[dict[str, Any]]:
+        return [
+            {
+                "names": ["--list", "-l"],
+                "help": "List all API keys",
+                "is_flag": True,
+                "is_option": True,
+            },
+            {
+                "names": ["--create", "-c"],
+                "help": "Create a new API key",
+                "is_flag": True,
+                "is_option": True,
+            },
+            {
+                "names": ["--show", "-s"],
+                "help": "Show details for a specific key",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--delete", "-d"],
+                "help": "Delete an API key",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--comment"],
+                "help": "Comment/label for new key",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--scopes"],
+                "help": "Comma-separated scopes for new key (default: member)",
+                "type": str,
+                "is_option": True,
+                "default": "member",
+            },
+            {
+                "names": ["--expiration-date"],
+                "help": "Expiration date for new key (ISO format)",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--ttl"],
+                "help": "Time to live in seconds for new key",
+                "type": int,
+                "is_option": True,
+            },
+            {
+                "names": ["--tags"],
+                "help": "Comma-separated tags for new key",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--status"],
+                "help": "Filter keys by status (active, expired)",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--project-id", "-p"],
+                "help": "Project ID (uses configured project if not provided)",
+                "type": str,
+                "is_option": True,
+            },
+            {
+                "names": ["--yes", "-y"],
+                "help": "Skip confirmation prompts",
+                "is_flag": True,
+                "is_option": True,
+            },
+        ]
+
+    def handle(
+        self,
+        config: Config,
+        auth_manager: AuthManager,
+        client: DeepgramClient,
+        **kwargs: Any,
+    ) -> BaseResult:
+        create_key = kwargs.get("create", False)
+        show_key = kwargs.get("show")
+        delete_key = kwargs.get("delete")
+        project_id = kwargs.get("project_id")
+
+        try:
+            if create_key:
+                return self._create_key(client, project_id, **kwargs)
+            elif show_key:
+                return self._show_key(client, show_key, project_id)
+            elif delete_key:
+                return self._delete_key(
+                    client, delete_key, project_id, kwargs.get("yes", False)
+                )
+            else:
+                # Default: list keys
+                return self._list_keys(client, project_id, kwargs.get("status"))
+
+        except Exception as e:
+            console.print(f"[red]Error:[/red] {e}")
+            return BaseResult(status="error", message=str(e))
+
+    def _list_keys(
+        self,
+        client: DeepgramClient,
+        project_id: str | None,
+        status: str | None,
+    ) -> BaseResult:
+        console.print("[blue]Fetching API keys...[/blue]")
+        result = client.list_keys(project_id=project_id, status=status)
+
+        keys_raw = result.get("api_keys", result.get("keys", []))
+        if not keys_raw:
+            console.print("[yellow]No API keys found[/yellow]")
+            return KeysResult(status="info", message="No keys found")
+
+        key_models: list[KeyInfo] = []
+        table = Table(title="API Keys", show_header=True, header_style="bold blue")
+        table.add_column("Comment", style="green")
+        table.add_column("Key ID", style="dim")
+        table.add_column("Scopes")
+        table.add_column("Created")
+        table.add_column("Expires")
+
+        for k in keys_raw:
+            # SDK may nest key data under "api_key"
+            key_data = k.get("api_key", k) if isinstance(k, dict) else k
+            if hasattr(key_data, "__dict__"):
+                key_data = key_data.__dict__
+
+            info = KeyInfo(
+                key_id=str(key_data.get("api_key_id", "")),
+                comment=str(key_data.get("comment", "")),
+                scopes=key_data.get("scopes", []),
+                created=str(key_data.get("created", "")),
+                expiration_date=str(key_data.get("expiration_date", "") or ""),
+                tags=key_data.get("tags", []),
+            )
+            key_models.append(info)
+
+            table.add_row(
+                info.comment or "(no comment)",
+                info.key_id,
+                ", ".join(info.scopes) if info.scopes else "-",
+                info.created[:10] if info.created else "-",
+                info.expiration_date[:10] if info.expiration_date else "never",
+            )
+
+        console.print(table)
+        console.print(f"\n[dim]{len(key_models)} key(s) found[/dim]")
+
+        return KeysResult(status="success", keys=key_models, count=len(key_models))
+
+    def _create_key(
+        self,
+        client: DeepgramClient,
+        project_id: str | None,
+        **kwargs: Any,
+    ) -> BaseResult:
+        comment = kwargs.get("comment", "")
+        scopes_str = kwargs.get("scopes", "member")
+        scopes = (
+            [s.strip() for s in scopes_str.split(",")] if scopes_str else ["member"]
+        )
+        expiration = kwargs.get("expiration_date")
+        ttl = kwargs.get("ttl")
+        tags_str = kwargs.get("tags")
+        tags = [t.strip() for t in tags_str.split(",")] if tags_str else None
+
+        console.print("[blue]Creating API key...[/blue]")
+
+        result = client.create_key(
+            project_id=project_id,
+            comment=comment,
+            scopes=scopes,
+            expiration_date=expiration,
+            time_to_live=ttl,
+            tags=tags,
+        )
+
+        key_id = result.get("api_key_id", "")
+        key_value = result.get("key", "")
+
+        console.print("[green]API key created successfully[/green]")
+        console.print(f"  Key ID:  {key_id}")
+        console.print(f"  Comment: {comment or '(none)'}")
+        console.print(f"  Scopes:  {', '.join(scopes)}")
+        if key_value:
+            console.print(f"\n  [bold yellow]Key: {key_value}[/bold yellow]")
+            console.print("[dim]  Save this key now — it won't be shown again.[/dim]")
+
+        created = KeyCreatedInfo(
+            key_id=key_id,
+            key=key_value,
+            comment=comment,
+            scopes=scopes,
+        )
+        return KeysResult(status="success", message="Key created", created_key=created)
+
+    def _show_key(
+        self,
+        client: DeepgramClient,
+        key_id: str,
+        project_id: str | None,
+    ) -> BaseResult:
+        console.print(f"[blue]Fetching key details:[/blue] {key_id}")
+        result = client.get_key(key_id, project_id=project_id)
+
+        key_data = result.get("api_key", result) if isinstance(result, dict) else result
+
+        info = KeyInfo(
+            key_id=str(key_data.get("api_key_id", "")),
+            comment=str(key_data.get("comment", "")),
+            scopes=key_data.get("scopes", []),
+            created=str(key_data.get("created", "")),
+            expiration_date=str(key_data.get("expiration_date", "") or ""),
+            tags=key_data.get("tags", []),
+        )
+
+        console.print("[green]Key Details:[/green]")
+        console.print(f"  Key ID:     {info.key_id}")
+        console.print(f"  Comment:    {info.comment or '(none)'}")
+        console.print(f"  Scopes:     {', '.join(info.scopes) if info.scopes else '-'}")
+        console.print(f"  Created:    {info.created or '-'}")
+        console.print(f"  Expires:    {info.expiration_date or 'never'}")
+        if info.tags:
+            console.print(f"  Tags:       {', '.join(info.tags)}")
+
+        return KeysResult(status="success", keys=[info], count=1)
+
+    def _delete_key(
+        self,
+        client: DeepgramClient,
+        key_id: str,
+        project_id: str | None,
+        yes: bool = False,
+    ) -> BaseResult:
+        if not yes and not self.confirm(
+            f"Delete API key {key_id}? This cannot be undone.", default=False
+        ):
+            return BaseResult(status="cancelled", message="Cancelled by user")
+
+        console.print(f"[blue]Deleting API key:[/blue] {key_id}")
+        client.delete_key(key_id, project_id=project_id)
+        console.print(f"[green]API key {key_id} deleted[/green]")
+        return BaseResult(status="success", message=f"Key {key_id} deleted")

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys/models.py

@@ -0,0 +1,25 @@
+"""Models for keys command."""
+
+from __future__ import annotations
+
+from deepctl_core import BaseResult
+from pydantic import BaseModel, Field
+
+
+class KeyInfo(BaseModel):
+    key_id: str = ""
+    comment: str = ""
+    scopes: list[str] = Field(default_factory=list)
+    created: str = ""
+    expiration_date: str = ""
+    tags: list[str] = Field(default_factory=list)
+
+
+class KeyCreatedInfo(KeyInfo):
+    key: str = ""  # Only available on creation
+
+
+class KeysResult(BaseResult):
+    keys: list[KeyInfo] = Field(default_factory=list)
+    count: int = 0
+    created_key: KeyCreatedInfo | None = None

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: deepctl-cmd-keys
+Version: 0.0.2
+Summary: API keys management command for deepctl
+Author-email: Deepgram <devrel@deepgram.com>
+Maintainer-email: Deepgram <devrel@deepgram.com>
+License-Expression: MIT
+Keywords: deepgram,cli,keys,api-keys
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: deepctl-core>=0.1.10
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pydantic>=2.0.0
+
+# deepctl-cmd-keys
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+API keys management command for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl keys` | `deepctl_cmd_keys.command:KeysCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+- `pydantic>=2.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/deepctl_cmd_keys/__init__.py
+src/deepctl_cmd_keys/command.py
+src/deepctl_cmd_keys/models.py
+src/deepctl_cmd_keys.egg-info/PKG-INFO
+src/deepctl_cmd_keys.egg-info/SOURCES.txt
+src/deepctl_cmd_keys.egg-info/dependency_links.txt
+src/deepctl_cmd_keys.egg-info/entry_points.txt
+src/deepctl_cmd_keys.egg-info/requires.txt
+src/deepctl_cmd_keys.egg-info/top_level.txt

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[deepctl.commands]
+keys = deepctl_cmd_keys.command:KeysCommand

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/requires.txt

@@ -0,0 +1,4 @@
+deepctl-core>=0.1.10
+click>=8.0.0
+rich>=13.0.0
+pydantic>=2.0.0

deepctl_cmd_keys-0.0.2/src/deepctl_cmd_keys.egg-info/top_level.txt

@@ -0,0 +1 @@
+deepctl_cmd_keys