cwms-cli 0.3.0__tar.gz → 0.3.2__tar.gz

{cwms_cli-0.3.0 → cwms_cli-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cwms-cli
-Version: 0.3.0
+Version: 0.3.2
 Summary: Command line utilities for Corps Water Management Systems (CWMS) python scripts. This is a collection of shared scripts across the enterprise Water Management Enterprise System (WMES) teams.
 License: LICENSE
 License-File: LICENSE

{cwms_cli-0.3.0 → cwms_cli-0.3.2}/cwmscli/__main__.py

@@ -8,11 +8,19 @@ import click
 from cwmscli.commands import commands_cwms
 from cwmscli.load import __main__ as load
 from cwmscli.usgs import usgs_group
+from cwmscli.utils.click_help import add_version_to_help_tree
 from cwmscli.utils.logging import LoggingConfig, setup_logging
 from cwmscli.utils.ssl_errors import is_cert_verify_error, ssl_help_text
+from cwmscli.utils.version import get_cwms_cli_version
 
 
 @click.group(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.version_option(
+    get_cwms_cli_version(),
+    "--version",
+    "-V",
+    message="cwms-cli version %(version)s",
+)
 @click.option(
     "--log-file",
     type=click.Path(dir_okay=False, writable=True, resolve_path=True),
@@ -46,6 +54,7 @@ cli.add_command(commands_cwms.shefcritimport)
 cli.add_command(commands_cwms.csv2cwms_cmd)
 cli.add_command(commands_cwms.blob_group)
 cli.add_command(load.load_group)
+add_version_to_help_tree(cli)
 
 
 def main() -> None:
@@ -60,9 +69,15 @@ def main() -> None:
         "on",
     }
     try:
+        if len(sys.argv) == 1:
+            cli.main(args=["--help"], prog_name="cwms-cli", standalone_mode=False)
+            raise SystemExit(0)
         cli(standalone_mode=False)
     except SystemExit:
         raise
+    except click.ClickException as e:
+        e.show()
+        raise SystemExit(e.exit_code)
     except Exception as e:
         if is_cert_verify_error(e) and not debug:
             # Keep this short, no stack trace.

{cwms_cli-0.3.0 → cwms_cli-0.3.2}/cwmscli/utils/__init__.py

@@ -1,4 +1,4 @@
-import logging
+import logging as py_logging
 
 import click
 
@@ -12,10 +12,10 @@ def to_uppercase(ctx, param, value):
 def _set_log_level(ctx, param, value):
     if value is None:
         return
-    level = getattr(logging, value.upper(), None)
+    level = getattr(py_logging, value.upper(), None)
     if level is None:
         raise click.BadParameter(f"Invalid log level: {value}")
-    logging.getLogger().setLevel(level)
+    py_logging.getLogger().setLevel(level)
     return value
 
 

cwms_cli-0.3.2/cwmscli/utils/click_help.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+import sys
+
+import click
+
+from cwmscli.utils import colors
+from cwmscli.utils.version import get_cwms_cli_version
+
+
+def _render_version_line(ctx: click.Context) -> str:
+    # Match existing CLI color behavior: disable color for non-TTY, --no-color, or --log-file.
+    argv = sys.argv[1:]
+    no_color = "--no-color" in argv
+    has_log_file = ("--log-file" in argv) or any(
+        arg.startswith("--log-file=") for arg in argv
+    )
+    allow_color = sys.stdout.isatty() and (not no_color) and (not has_log_file)
+    colors.set_enabled(allow_color)
+    return f"Version: {colors.c(get_cwms_cli_version(), 'cyan', bright=True)}"
+
+
+def _inject_version_line(help_text: str, ctx: click.Context) -> str:
+    lines = help_text.splitlines()
+    if not lines:
+        return help_text
+
+    plain_version_line = f"Version: {get_cwms_cli_version()}"
+    if any(line.strip() == plain_version_line for line in lines):
+        return help_text
+
+    version_line = _render_version_line(ctx)
+    if lines[0].startswith("Usage:"):
+        lines.insert(1, version_line)
+    else:
+        lines.insert(0, version_line)
+    return "\n".join(lines)
+
+
+def _wrap_get_help(command: click.Command) -> None:
+    original_get_help = command.get_help
+
+    def get_help_with_version(ctx: click.Context) -> str:
+        return _inject_version_line(original_get_help(ctx), ctx)
+
+    command.get_help = get_help_with_version  # type: ignore[method-assign]
+
+
+def add_version_to_help_tree(command: click.Command) -> None:
+    """Patch a command tree so every help output shows the CLI version."""
+    stack = [command]
+    seen: set[int] = set()
+
+    while stack:
+        cmd = stack.pop()
+        obj_id = id(cmd)
+        if obj_id in seen:
+            continue
+        seen.add(obj_id)
+
+        _wrap_get_help(cmd)
+
+        if isinstance(cmd, click.Group):
+            stack.extend(cmd.commands.values())

cwms_cli-0.3.2/cwmscli/utils/version.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+import re
+from functools import lru_cache
+from importlib import metadata
+from pathlib import Path
+
+
+@lru_cache(maxsize=1)
+def get_cwms_cli_version() -> str:
+    """Return installed cwms-cli version, with pyproject fallback for source runs."""
+    try:
+        return metadata.version("cwms-cli")
+    except metadata.PackageNotFoundError:
+        pass
+
+    pyproject = Path(__file__).resolve().parents[2] / "pyproject.toml"
+    if not pyproject.exists():
+        return "unknown"
+
+    text = pyproject.read_text(encoding="utf-8")
+
+    # Prefer the [tool.poetry] version declaration.
+    in_poetry_section = False
+    for line in text.splitlines():
+        stripped = line.strip()
+        if stripped.startswith("[") and stripped.endswith("]"):
+            in_poetry_section = stripped == "[tool.poetry]"
+            continue
+        if in_poetry_section:
+            m = re.match(r'^version\s*=\s*"([^"]+)"\s*$', stripped)
+            if m:
+                return m.group(1)
+
+    return "unknown"

{cwms_cli-0.3.0 → cwms_cli-0.3.2}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "cwms-cli"
 repository = "https://github.com/HydrologicEngineeringCenter/cwms-cli"
 
-version = "0.3.0"
+version = "0.3.2"
 
 
 packages = [