qualys-cli 0.3.0__tar.gz → 0.3.1__tar.gz

{qualys_cli-0.3.0 → qualys_cli-0.3.1}/CHANGELOG.md

@@ -6,6 +6,15 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.3.1] — 2026-11-04
+
+### Fixed
+- `qualys-cli completion <shell>` printed only a "Tip:" line instead of the
+  completion script, so shell tab completion could not be set up. It asked
+  Typer for the script with Click's env-var format (`zsh_source`) instead of
+  Typer's (`source_zsh`); the script is now generated in-process. Workaround
+  for 0.3.0: `_QUALYS_CLI_COMPLETE=source_zsh qualys-cli > <fpath-dir>/_qualys-cli`.
+
 ## [0.3.0] — 2026-11-03
 
 ### Added

{qualys_cli-0.3.0 → qualys_cli-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: qualys-cli
-Version: 0.3.0
+Version: 0.3.1
 Summary: Unified command-line interface for the Qualys Cloud Platform REST APIs (VM, PC, PM, ETM, WAS, TotalCloud, Cloud Agent, Container Security, CSAM, Subscription, Asset, and User management).
 Project-URL: Homepage, https://www.qualys.com
 Author-email: Qualys <support@qualys.com>

{qualys_cli-0.3.0 → qualys_cli-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "qualys-cli"
-version = "0.3.0"
+version = "0.3.1"
 description = "Unified command-line interface for the Qualys Cloud Platform REST APIs (VM, PC, PM, ETM, WAS, TotalCloud, Cloud Agent, Container Security, CSAM, Subscription, Asset, and User management)."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }

qualys_cli-0.3.1/src/qualys_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.1"

{qualys_cli-0.3.0 → qualys_cli-0.3.1}/src/qualys_cli/_docs/usage.html

@@ -612,7 +612,7 @@ body.filtering.no-match section.module{display:none}
 <aside class="sidebar" aria-label="Documentation navigation">
   <div class="side-header">
     <img src="https://ik.imagekit.io/qualys/image/logo/qualys.svg" alt="Qualys">
-    <span class="ver">v0.3.0</span>
+    <span class="ver">v0.3.1</span>
   </div>
   <div class="side-search">
     <input type="search" id="filter" placeholder="Search commands…"
@@ -696,7 +696,7 @@ body.filtering.no-match section.module{display:none}
     <div class="hero-stats">
       <div class="hero-stat"><span class="n">28</span><span class="l">Modules</span></div>
       <div class="hero-stat"><span class="n">271</span><span class="l">Commands</span></div>
-      <div class="hero-stat"><span class="n">v0.3.0</span><span class="l">Version</span></div>
+      <div class="hero-stat"><span class="n">v0.3.1</span><span class="l">Version</span></div>
       <div class="hero-stat"><span class="n">3.12+</span><span class="l">Python</span></div>
       <div class="hero-stat"><span class="n">MIT</span><span class="l">License</span></div>
     </div>

{qualys_cli-0.3.0 → qualys_cli-0.3.1}/src/qualys_cli/extras.py

@@ -603,23 +603,29 @@ completion_app = typer.Typer(invoke_without_command=False, help="Print a shell-c
 def completion(
     shell: str = typer.Argument("bash", help="bash | zsh | fish | powershell"),
 ) -> None:
-    """Print the completion script for *shell* to stdout — eval / source it."""
+    """Print the completion script for *shell* to stdout — eval / source it.
+
+    zsh:   qualys-cli completion zsh > ~/.oh-my-zsh/custom/completions/_qualys-cli
+    bash:  eval "$(qualys-cli completion bash)"
+    """
+    # Defined in typer._completion_shared; typer.completion only re-exports it
+    # implicitly, which strict mypy (no_implicit_reexport) rejects.
+    from typer._completion_shared import get_completion_script
+
     shell = shell.lower()
     valid = {"bash", "zsh", "fish", "powershell"}
     if shell not in valid:
         _err.print(f"[bold red]Unsupported shell:[/bold red] {shell}. Choose one of {sorted(valid)}.")
         raise typer.Exit(2)
-    env = os.environ | {"_QUALYS_CLI_COMPLETE": f"{shell}_source"}
-    proc = subprocess.run(
-        ["qualys-cli"], env=env, capture_output=True, text=True, check=False,
-    )
-    sys.stdout.write(proc.stdout)
-    if proc.returncode != 0:
-        _err.print(
-            "[dim]Tip: install the script by piping it into a file in your shell's "
-            "completions directory. See: https://typer.tiangolo.com/tutorial/options-autocompletion/[/dim]"
+    # Generated in-process. The previous implementation re-ran `qualys-cli`
+    # with _QUALYS_CLI_COMPLETE=<shell>_source — Click's env format — but
+    # Typer expects source_<shell>; it answered "Shell source not supported",
+    # so no script was ever printed and tab completion could not be set up.
+    sys.stdout.write(
+        get_completion_script(
+            prog_name="qualys-cli", complete_var="_QUALYS_CLI_COMPLETE", shell=shell,
         )
-        raise typer.Exit(proc.returncode)
+    )
 
 
 # ---------------------------------------------------------------------------

qualys_cli-0.3.1/tests/test_completion.py

@@ -0,0 +1,61 @@
+"""Shell tab-completion: script generation and the completion engine it calls."""
+
+from __future__ import annotations
+
+import pytest
+from typer.testing import CliRunner
+
+from qualys_cli.cli import app
+
+runner = CliRunner()
+
+
+@pytest.mark.parametrize(
+    ("shell", "marker"),
+    [
+        ("zsh", "#compdef qualys-cli"),
+        ("bash", "complete -o"),
+        ("fish", "complete --command qualys-cli"),
+        ("powershell", "Register-ArgumentCompleter"),
+    ],
+)
+def test_completion_prints_script(shell: str, marker: str) -> None:
+    result = runner.invoke(app, ["completion", shell])
+    assert result.exit_code == 0, result.output
+    assert marker in result.stdout
+    # The script must call back into the CLI with the matching env var.
+    assert "_QUALYS_CLI_COMPLETE" in result.stdout
+
+
+def test_completion_rejects_unknown_shell() -> None:
+    result = runner.invoke(app, ["completion", "tcsh"])
+    assert result.exit_code == 2
+
+
+def _complete(line: str) -> str:
+    result = runner.invoke(
+        app,
+        [],
+        prog_name="qualys-cli",
+        env={"_QUALYS_CLI_COMPLETE": "complete_zsh", "_TYPER_COMPLETE_ARGS": line},
+    )
+    assert result.exit_code == 0, result.output
+    return result.stdout
+
+
+def test_completion_engine_lists_modules() -> None:
+    out = _complete("qualys-cli ")
+    for module in ("vm", "pc", "cs", "etm", "pm", "ca", "was", "csam"):
+        assert f'"{module}":' in out
+
+
+def test_completion_engine_lists_module_resources() -> None:
+    out = _complete("qualys-cli cs ")
+    for resource in ("image", "k8s-resource", "secret-detector", "qid-list", "tag"):
+        assert f'"{resource}":' in out
+
+
+def test_completion_engine_lists_resource_actions() -> None:
+    out = _complete("qualys-cli etm finding ")
+    for action in ("list", "get", "count"):
+        assert f'"{action}":' in out

qualys_cli-0.3.0/src/qualys_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.3.0"