deepctl-cmd-completion 0.0.2__py3-none-any.whl

deepctl_cmd_completion/__init__.py

@@ -0,0 +1 @@
+"""Shell completion command for deepctl."""

deepctl_cmd_completion/command.py

@@ -0,0 +1,191 @@
+"""Shell completion command for deepctl."""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+from typing import Any
+
+from deepctl_core import AuthManager, BaseCommand, BaseResult, Config, DeepgramClient
+from rich.console import Console
+
+console = Console()
+
+# Click derives the completion env var from the invocation name.
+# Users call the CLI as "dg", so the var is _DG_COMPLETE.
+_SHELLS: dict[str, dict[str, str]] = {
+    "bash": {
+        "eval_line": 'eval "$(_DG_COMPLETE=bash_source dg)"',
+        "profile": "~/.bashrc",
+        "check_marker": "_DG_COMPLETE=bash_source",
+    },
+    "zsh": {
+        "eval_line": 'eval "$(_DG_COMPLETE=zsh_source dg)"',
+        "profile": "~/.zshrc",
+        "check_marker": "_DG_COMPLETE=zsh_source",
+    },
+    "fish": {
+        "eval_line": "eval (env _DG_COMPLETE=fish_source dg)",
+        "profile": "~/.config/fish/config.fish",
+        "check_marker": "_DG_COMPLETE=fish_source",
+    },
+}
+
+
+class CompletionResult(BaseResult):
+    """Return structure for the completion command."""
+
+    shell: str
+    eval_line: str
+    installed: bool = False
+    install_path: str | None = None
+
+
+class CompletionCommand(BaseCommand):
+    """Generate shell completion scripts for dg."""
+
+    name = "completion"
+    help = "Generate shell completion script for bash, zsh, or fish"
+    short_help = "Generate shell completion"
+
+    requires_auth = False
+    requires_project = False
+    ci_friendly = True
+
+    examples = [
+        "dg completion",
+        "dg completion bash",
+        "dg completion zsh",
+        "dg completion fish",
+        'eval "$(dg completion bash)"',
+        "dg completion zsh --install",
+    ]
+    agent_help = (
+        "Output the shell completion eval line for bash, zsh, or fish. "
+        "Source the output to enable tab-completion for all dg commands, "
+        "options, and arguments. Use --install to append to the shell profile "
+        "automatically. Shell is auto-detected from $SHELL if not specified."
+    )
+
+    def get_arguments(self) -> list[dict[str, Any]]:
+        """Get command arguments."""
+        return [
+            {
+                "name": "shell",
+                "help": "Shell type: bash, zsh, fish (auto-detected if omitted)",
+                "type": str,
+                "required": False,
+                "nargs": 1,
+            },
+            {
+                "names": ["--install"],
+                "help": "Append completion line to shell profile and exit",
+                "is_flag": True,
+                "is_option": True,
+            },
+        ]
+
+    def handle(
+        self,
+        config: Config,
+        auth_manager: AuthManager,
+        client: DeepgramClient,
+        **kwargs: Any,
+    ) -> Any:
+        """Handle completion command."""
+        shell = kwargs.get("shell") or self._detect_shell()
+        install = kwargs.get("install", False)
+
+        if shell not in _SHELLS:
+            console.print(
+                f"[red]Unknown shell:[/red] {shell!r}. Supported: {', '.join(_SHELLS)}"
+            )
+            return BaseResult(
+                status="error",
+                message=f"Unknown shell: {shell}",
+            )
+
+        cfg = _SHELLS[shell]
+        eval_line = cfg["eval_line"]
+        profile_path = Path(cfg["profile"]).expanduser()
+
+        if install:
+            return self._install(shell, eval_line, cfg["check_marker"], profile_path)
+
+        # Just print the eval line — users can pipe it directly:
+        #   eval "$(dg completion bash)"
+        console.print(eval_line)
+        console.print(
+            f"\n[dim]Add the above line to {cfg['profile']},"
+            f" or run:[/dim]\n"
+            f"  [bold]dg completion {shell} --install[/bold]",
+            highlight=False,
+        )
+
+        return CompletionResult(
+            status="success",
+            shell=shell,
+            eval_line=eval_line,
+        )
+
+    def _detect_shell(self) -> str:
+        """Detect the current shell from $SHELL."""
+        shell_bin = os.environ.get("SHELL", "")
+        if "zsh" in shell_bin:
+            return "zsh"
+        if "fish" in shell_bin:
+            return "fish"
+        return "bash"
+
+    def _install(
+        self,
+        shell: str,
+        eval_line: str,
+        check_marker: str,
+        profile_path: Path,
+    ) -> CompletionResult:
+        """Append the completion line to the shell profile."""
+        try:
+            profile_path.parent.mkdir(parents=True, exist_ok=True)
+
+            # Idempotent: skip if already present
+            if profile_path.exists():
+                existing = profile_path.read_text()
+                if check_marker in existing:
+                    console.print(
+                        f"[yellow]Already installed[/yellow] in {profile_path}"
+                    )
+                    return CompletionResult(
+                        status="info",
+                        message="Already installed",
+                        shell=shell,
+                        eval_line=eval_line,
+                        installed=False,
+                        install_path=str(profile_path),
+                    )
+
+            with profile_path.open("a") as f:
+                f.write(f"\n# deepctl (dg) shell completion\n{eval_line}\n")
+
+            console.print(f"[green]✓[/green] Completion installed to {profile_path}")
+            console.print(
+                f"[dim]Restart your shell or run:[/dim]  source {profile_path}"
+            )
+
+            return CompletionResult(
+                status="success",
+                message=f"Installed to {profile_path}",
+                shell=shell,
+                eval_line=eval_line,
+                installed=True,
+                install_path=str(profile_path),
+            )
+
+        except OSError as e:
+            console.print(f"[red]Failed to write to {profile_path}:[/red] {e}")
+            return CompletionResult(
+                status="error",
+                message=str(e),
+                shell=shell,
+                eval_line=eval_line,
+            )

deepctl_cmd_completion-0.0.2.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: deepctl-cmd-completion
+Version: 0.0.2
+Summary: Shell completion command for deepctl
+Author-email: Deepgram <devrel@deepgram.com>
+Maintainer-email: Deepgram <devrel@deepgram.com>
+License-Expression: MIT
+Keywords: deepgram,cli,completion,shell
+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-completion
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+Shell completion 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 completion` | `deepctl_cmd_completion.command:CompletionCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+- `pydantic>=2.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_cmd_completion-0.0.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+deepctl_cmd_completion/__init__.py,sha256=35Z7fNH5Co2IxlNhmgKY1nBFLO5U_WUfGSqazP7dNiQ,44
+deepctl_cmd_completion/command.py,sha256=c-Kk2TmkzTGt5QxRH15b5EYZzAXpDhtgvWZQzwIMS3c,6048
+deepctl_cmd_completion-0.0.2.dist-info/METADATA,sha256=T6dpZYi5BbVEN49MDRlRRfgSqJsDMf4rHm3OfIBwRqA,1494
+deepctl_cmd_completion-0.0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+deepctl_cmd_completion-0.0.2.dist-info/entry_points.txt,sha256=oJLkLkH_Bv0VFo6vBYeO44YzlJ8VV3FzPuwjN_JqOEg,81
+deepctl_cmd_completion-0.0.2.dist-info/top_level.txt,sha256=23ntLi94J3u_wNZx-mewImqoiMmwUhjYnhTjUy8F4jo,23
+deepctl_cmd_completion-0.0.2.dist-info/RECORD,,

deepctl_cmd_completion-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

deepctl_cmd_completion-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[deepctl.commands]
+completion = deepctl_cmd_completion.command:CompletionCommand

deepctl_cmd_completion-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+deepctl_cmd_completion