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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cwms-cli
-Version: 0.2.1
+Version: 0.3.0
 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
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: click (>=8.1.8,<9.0.0)
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
 Project-URL: Repository, https://github.com/HydrologicEngineeringCenter/cwms-cli
 Description-Content-Type: text/markdown
 
@@ -24,7 +25,7 @@ Description-Content-Type: text/markdown
 
 A collection of scripts to create, read, update, list, and delete data through CWMS Data API (CDA) and other commonly used API in the US Army Corps of Engineers water management. CWMS-CLI wraps these API in a friendly to use terminal based interface.
 
-[![Docs](https://readthedocs.org/projects/cwms-cli/badge/?version=latest)](https://cwms-cli.readthedocs.io/en/latest/) - 📖 Read the docs: https://cwms-cli.readthedocs.io/en/latest/
+[![Docs](https://readthedocs.org/projects/cwms-cli/badge/?version=latest)](https://cwms-cli.readthedocs.io/en/latest/cli.html#cwms-cli) - 📖 Read the docs: https://cwms-cli.readthedocs.io/en/latest/
 
 ## Install
 

{cwms_cli-0.2.1 → cwms_cli-0.3.0}/README.md

@@ -2,7 +2,7 @@
 
 A collection of scripts to create, read, update, list, and delete data through CWMS Data API (CDA) and other commonly used API in the US Army Corps of Engineers water management. CWMS-CLI wraps these API in a friendly to use terminal based interface.
 
-[![Docs](https://readthedocs.org/projects/cwms-cli/badge/?version=latest)](https://cwms-cli.readthedocs.io/en/latest/) - 📖 Read the docs: https://cwms-cli.readthedocs.io/en/latest/
+[![Docs](https://readthedocs.org/projects/cwms-cli/badge/?version=latest)](https://cwms-cli.readthedocs.io/en/latest/cli.html#cwms-cli) - 📖 Read the docs: https://cwms-cli.readthedocs.io/en/latest/
 
 ## Install
 

cwms_cli-0.3.0/cwmscli/__main__.py

@@ -0,0 +1,80 @@
+import logging
+import os
+import sys
+from typing import Optional
+
+import click
+
+from cwmscli.commands import commands_cwms
+from cwmscli.load import __main__ as load
+from cwmscli.usgs import usgs_group
+from cwmscli.utils.logging import LoggingConfig, setup_logging
+from cwmscli.utils.ssl_errors import is_cert_verify_error, ssl_help_text
+
+
+@click.group(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.option(
+    "--log-file",
+    type=click.Path(dir_okay=False, writable=True, resolve_path=True),
+    default=None,
+    help="Write logs to a file. If set, disables color completely.",
+)
+@click.option(
+    "--no-color",
+    is_flag=True,
+    default=False,
+    help="Disable colored output in the terminal.",
+)
+@click.option(
+    "--log-level",
+    type=click.Choice(
+        ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], case_sensitive=False
+    ),
+    default="INFO",
+)
+def cli(log_file: Optional[str], no_color: bool, log_level: str) -> None:
+    level = getattr(logging, log_level.upper(), logging.INFO)
+
+    # Disable colors if stdout isn't a TTY (piped/redirected)
+    tty = sys.stdout.isatty()
+    color = (not no_color) and tty
+    setup_logging(LoggingConfig(level=level, log_file=log_file, color=color))
+
+
+cli.add_command(usgs_group, name="usgs")
+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)
+
+
+def main() -> None:
+    """
+    Entrypoint wrapper so we can print friendly guidance without a traceback
+    for known TLS/cert issues.
+    """
+    debug = os.getenv("CWMS_CLI_DEBUG", "").strip().lower() in {
+        "1",
+        "true",
+        "yes",
+        "on",
+    }
+    try:
+        cli(standalone_mode=False)
+    except SystemExit:
+        raise
+    except Exception as e:
+        if is_cert_verify_error(e) and not debug:
+            # Keep this short, no stack trace.
+            logging.error(
+                "SSL certificate verification failed while connecting to the server."
+            )
+            click.echo(ssl_help_text(), err=True)
+            raise SystemExit(2)
+
+        # If debug is enabled (or it's not a cert verify error), keep the normal failure behavior.
+        raise
+
+
+if __name__ == "__main__":
+    main()

{cwms_cli-0.2.1 → cwms_cli-0.3.0}/cwmscli/commands/blob.py

@@ -326,7 +326,7 @@ def download_cmd(
             f"DRY RUN: would GET {api_root} blob with blob-id={blob_id} office={office}."
         )
         return
-    cwms.init_session(api_root=api_root, api_key=get_api_key(api_key, ""))
+    cwms.init_session(api_root=api_root)
     bid = blob_id.upper()
     logging.debug(f"Office={office} BlobID={bid}")
 
@@ -419,7 +419,7 @@ def list_cmd(
     import cwms
     import pandas as pd
 
-    cwms.init_session(api_root=api_root, api_key=get_api_key(api_key, None))
+    cwms.init_session(api_root=api_root)
     df = list_blobs(
         office=office,
         blob_id_like=blob_id_like,

{cwms_cli-0.2.1 → cwms_cli-0.3.0}/cwmscli/commands/commands_cwms.py

@@ -5,7 +5,7 @@ import click
 from cwmscli import requirements as reqs
 from cwmscli.callbacks import csv_to_list
 from cwmscli.commands import csv2cwms
-from cwmscli.utils import api_key_loc_option, common_api_options
+from cwmscli.utils import api_key_loc_option, common_api_options, to_uppercase
 from cwmscli.utils.deps import requires
 
 
@@ -251,6 +251,3 @@ def list_cmd(**kwargs):
     from cwmscli.commands.blob import list_cmd
 
     list_cmd(**kwargs)
-
-
-# endregion

{cwms_cli-0.2.1 → cwms_cli-0.3.0}/cwmscli/usgs/__init__.py

@@ -118,13 +118,15 @@ def ratingsinifileimport(filename, api_root, api_key, api_key_loc):
 @click.option(
     "-d",
     "--days-back-modified",
-    default="2",
+    default=2,
+    type=int,
     help="Days back from current time measurements have been modified in USGS database. Can be integer value",
 )
 @click.option(
     "-c",
     "--days-back-collected",
-    default="365",
+    default=365,
+    type=int,
     help="Days back from current time measurements have been collected. Can be integer value",
 )
 @office_option

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

@@ -1,3 +1,5 @@
+import logging
+
 import click
 
 
@@ -7,6 +9,16 @@ def to_uppercase(ctx, param, value):
     return value.upper()
 
 
+def _set_log_level(ctx, param, value):
+    if value is None:
+        return
+    level = getattr(logging, value.upper(), None)
+    if level is None:
+        raise click.BadParameter(f"Invalid log level: {value}")
+    logging.getLogger().setLevel(level)
+    return value
+
+
 office_option = click.option(
     "-o",
     "--office",
@@ -47,6 +59,18 @@ api_key_loc_option = click.option(
     type=str,
     help="file storing Api Key. One of api-key or api-key-loc are required",
 )
+log_level_option = click.option(
+    "--log-level",
+    type=click.Choice(
+        ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], case_sensitive=False
+    ),
+    default="INFO",
+    envvar="LOG_LEVEL",
+    callback=_set_log_level,
+    expose_value=False,  # Callback will set the log level of all methods
+    is_eager=True,  # Run before other commands (to cover any logging statements)
+    help="Set logging verbosity (overrides default INFO).",
+)
 
 
 def get_api_key(api_key: str, api_key_loc: str) -> str:
@@ -62,6 +86,7 @@ def get_api_key(api_key: str, api_key_loc: str) -> str:
 
 
 def common_api_options(f):
+    f = log_level_option(f)
     f = office_option(f)
     f = api_root_option(f)
     f = api_key_option(f)

cwms_cli-0.3.0/cwmscli/utils/colors.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from colorama import Fore, Style
+
+_ENABLED: bool = False
+
+
+def set_enabled(enabled: bool) -> None:
+    global _ENABLED
+    _ENABLED = enabled
+
+
+def c(text: str, color: str, bright: bool = False) -> str:
+    if not _ENABLED:
+        return text
+    b = Style.BRIGHT if bright else ""
+    # Find the color in Fore and apply it to the text, then reset the style at the end
+    if hasattr(Fore, color.upper()):
+        color = getattr(Fore, color.upper())
+    else:
+        color = ""
+    return f"{color}{b}{text}{Style.RESET_ALL}"
+
+
+def ok(text: str) -> str:
+    return c(text, Fore.GREEN)
+
+
+def warn(text: str) -> str:
+    return c(text, Fore.YELLOW, bright=True)
+
+
+def err(text: str) -> str:
+    return c(text, Fore.RED, bright=True)
+
+
+def dim(text: str) -> str:
+    return c(text, Fore.WHITE, bright=False)

cwms_cli-0.3.0/cwmscli/utils/io.py

@@ -0,0 +1,16 @@
+import logging
+import os
+from pathlib import Path
+
+
+def write_to_file(file_path: str, data: str, create_dir: bool = False) -> None:
+    """Writes data to a file at the specified path."""
+    if not file_path:
+        raise ValueError("You must specify a file path to write data to.")
+    if not data:
+        raise ValueError("No data provided to write to file.")
+    if create_dir:
+        Path(os.path.dirname(file_path)).mkdir(parents=True, exist_ok=True)
+    with open(file_path, "w") as file:
+        file.write(data)
+    logging.info(f"Data written to file: {file_path}")

cwms_cli-0.3.0/cwmscli/utils/logging/__init__.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+import logging
+import sys
+from dataclasses import dataclass
+from typing import Optional
+
+from colorama import Fore, Style
+from colorama import init as colorama_init
+
+from cwmscli.utils import colors
+
+
+@dataclass(frozen=True)
+class LoggingConfig:
+    level: int = logging.INFO
+    log_file: Optional[str] = None
+    color: bool = True
+
+
+class ColorLevelFormatter(logging.Formatter):
+    def __init__(self, fmt: str, datefmt: str, enable_color: bool) -> None:
+        super().__init__(fmt=fmt, datefmt=datefmt)
+        self._enable_color = enable_color
+
+    def format(self, record: logging.LogRecord) -> str:
+        original = record.levelname
+        try:
+            if self._enable_color:
+                record.levelname = self._color_levelname(
+                    record.levelname, record.levelno
+                )
+            # Make a copy of the record to avoid mutating the original, since format() can be called multiple times for the same record by multiple handlers
+            return super().format(record)
+        finally:
+            record.levelname = original
+
+    @staticmethod
+    def _color_datetime(dt_str: str) -> str:
+        return f"{Fore.CYAN}{dt_str}{Style.RESET_ALL}"
+
+    @staticmethod
+    def _color_levelname(levelname: str, levelno: int) -> str:
+        # Color the LOG LEVEL
+        if levelno >= logging.CRITICAL:
+            return f"{Fore.MAGENTA}{Style.BRIGHT}{levelname}{Style.RESET_ALL}"
+        if levelno >= logging.ERROR:
+            return f"{Fore.RED}{Style.BRIGHT}{levelname}{Style.RESET_ALL}"
+        if levelno >= logging.WARNING:
+            return f"{Fore.YELLOW}{Style.BRIGHT}{levelname}{Style.RESET_ALL}"
+        if levelno >= logging.INFO:
+            return f"{Fore.GREEN}{levelname}{Style.RESET_ALL}"
+        return f"{Fore.CYAN}{levelname}{Style.RESET_ALL}"
+
+
+def setup_logging(cfg: LoggingConfig) -> None:
+    root = logging.getLogger()
+    # Clear existing handlers
+    if root.hasHandlers():
+        root.handlers.clear()
+
+    root.setLevel(cfg.level)
+    root.propagate = False
+
+    # If a log file is specified, disable color completely
+    color_enabled = False if cfg.log_file else cfg.color
+
+    # Initialize colorama once, per the docs. Do NOT intialize colorama in each handler/formatter
+    colorama_init(autoreset=True, strip=not color_enabled)
+    colors.set_enabled(color_enabled)
+
+    base_fmt = "%(asctime)s;%(levelname)s;%(message)s"
+    date_fmt = "%Y-%m-%d %H:%M:%S"
+    stream_handler = logging.StreamHandler(sys.stdout)
+    stream_handler.setFormatter(ColorLevelFormatter(base_fmt, date_fmt, color_enabled))
+    root.addHandler(stream_handler)
+
+    if cfg.log_file:
+        file_handler = logging.FileHandler(cfg.log_file, encoding="utf-8")
+        file_handler.setFormatter(logging.Formatter(base_fmt, date_fmt))
+        root.addHandler(file_handler)
+    logging.getLogger().info("logger configured")

cwms_cli-0.3.0/cwmscli/utils/logging/formatters.py

@@ -0,0 +1,105 @@
+import json
+import re
+from typing import Any, Callable, Dict, List, Optional
+
+import pandas as pd
+
+ColorFn = Callable[[str, str], str]  # e.g. c("text", "BLUE")
+
+
+_JSON_START = re.compile(r"^\s*[\{\[]")
+# Very lightweight JSON "syntax highlighting" (works on pretty-printed JSON)
+_JSON_TOKENS = re.compile(
+    r'(?P<key>"(?:\\.|[^"\\])*")\s*:'
+    r"|(?P<string>\"(?:\\.|[^\"\\])*\")"
+    r"|(?P<number>-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?)"
+    r"|(?P<bool>\btrue\b|\bfalse\b)"
+    r"|(?P<null>\bnull\b)"
+)
+
+
+def _maybe_parse_json(s: str) -> Optional[Any]:
+    if not _JSON_START.match(s):
+        return None
+    try:
+        return json.loads(s)
+    except Exception:
+        return None
+
+
+def _colorize_json(pretty_json: str, c: ColorFn) -> str:
+    def repl(m: re.Match[str]) -> str:
+        if m.group("key") is not None:
+            # key token (still includes quotes)
+            return f'{c(m.group("key"), "CYAN")}:'
+        if m.group("string") is not None:
+            return c(m.group("string"), "GREEN")
+        if m.group("number") is not None:
+            return c(m.group("number"), "MAGENTA")
+        if m.group("bool") is not None:
+            return c(m.group("bool"), "YELLOW")
+        if m.group("null") is not None:
+            return c(m.group("null"), "RED")
+        return m.group(0)
+
+    return _JSON_TOKENS.sub(repl, pretty_json)
+
+
+def _format_cell(val: Any, *, c: ColorFn, json_color: bool) -> str:
+    s = "" if val is None else str(val)
+
+    if json_color:
+        obj = _maybe_parse_json(s)
+        if obj is not None:
+            pretty = json.dumps(obj, indent=2, sort_keys=True)
+            return _colorize_json(pretty, c)
+
+    return s
+
+
+def format_df_for_log(
+    df: pd.DataFrame,
+    *,
+    c: ColorFn,
+    col_colors: Optional[Dict[int, str]] = None,
+    json_color: bool = True,
+    max_rows: int = 500,
+) -> str:
+    """
+    Formats a pandas DataFrame for logging, applying optional colorization to columns and JSON values.
+    This function iterates over the rows of the provided DataFrame and formats each cell for logging.
+    You can specify colors for particular columns and whether to colorize JSON values. The output is a
+    string suitable for logging, with each row on a new line.
+    Args:
+        df (pd.DataFrame): The DataFrame to format.
+        c (ColorFn): A function that applies color to a string, e.g., c(text, color_name).
+        col_colors (Optional[Dict[int, str]], optional): A mapping from column indices to color names.
+            If None, defaults to {0: "BLUE", 1: "GREEN"}.
+        json_color (bool, optional): Whether to apply colorization to JSON values. Defaults to True.
+        max_rows (int, optional): Maximum number of rows to display. Defaults to 500.
+    Returns:
+        str: The formatted string representation of the DataFrame for logging.
+    Examples:
+        >>> import pandas as pd
+        >>> def color_fn(text, color): return f"<{color}>{text}</{color}>"
+        >>> df = pd.DataFrame({'A': [1, 2], 'B': ['x', 'y']})
+        >>> print(format_df_for_log(df, c=color_fn, col_colors={0: "RED", 1: "GREEN"}))
+        <RED>1</RED>  <GREEN>x</GREEN>
+        <RED>2</RED>  <GREEN>y</GREEN>
+
+    """
+    col_colors = col_colors or {0: "BLUE", 1: "GREEN"}
+
+    lines: List[str] = []
+    with pd.option_context("display.max_rows", max_rows, "display.max_columns", None):
+        for row in df.itertuples(index=False, name=None):
+            parts: List[str] = []
+            for idx, val in enumerate(row):
+                cell = _format_cell(val, c=c, json_color=json_color)
+                if idx in col_colors:
+                    parts.append(c(cell, col_colors[idx]))
+                else:
+                    parts.append(cell)
+            lines.append("  ".join(parts))
+
+    return "\n".join(lines)

cwms_cli-0.3.0/cwmscli/utils/ssl_errors.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+import os
+import ssl
+import sys
+from typing import Iterable, Optional, Set
+
+
+def _walk_exception_chain(exc: BaseException) -> Iterable[BaseException]:
+    seen: Set[int] = set()
+    cur: Optional[BaseException] = exc
+    while cur is not None and id(cur) not in seen:
+        seen.add(id(cur))
+        yield cur
+        cur = cur.__cause__ or cur.__context__
+
+
+def is_cert_verify_error(exc: BaseException) -> bool:
+    try:
+        import requests
+    except Exception:
+        requests = None
+
+    try:
+        import urllib3
+    except Exception:
+        urllib3 = None
+
+    for e in _walk_exception_chain(exc):
+        if isinstance(e, ssl.SSLCertVerificationError):
+            return True
+        if isinstance(e, ssl.SSLError) and "CERTIFICATE_VERIFY_FAILED" in str(e):
+            return True
+        if requests is not None:
+            if isinstance(e, getattr(requests.exceptions, "SSLError", ())):
+                if (
+                    "CERTIFICATE_VERIFY_FAILED" in str(e)
+                    or "certificate verify failed" in str(e).lower()
+                ):
+                    return True
+        if urllib3 is not None:
+            if isinstance(e, getattr(urllib3.exceptions, "SSLError", ())):
+                if (
+                    "CERTIFICATE_VERIFY_FAILED" in str(e)
+                    or "certificate verify failed" in str(e).lower()
+                ):
+                    return True
+    return False
+
+
+def ssl_help_text() -> str:
+    if os.name == "nt" or sys.platform.startswith("win"):
+        return (
+            "TLS certificate verification failed.\n\n"
+            "Windows fix (recommended):\n"
+            "  python -m pip install --upgrade pip-system-certs\n\n"
+            "Then re-run your command.\n"
+        )
+
+    if sys.platform.startswith(("sunos", "sunos5", "solaris")):
+        return (
+            "TLS certificate verification failed.\n\n"
+            "Solaris fix: configure Python/requests to use your system/DoD trust bundle.\n"
+            "Add one of these to your shell profile (e.g., ~/.bashrc) and start a new shell:\n\n"
+            "  export SSL_CERT_FILE=/path/to/your/dod_ca_bundle.pem\n"
+            "  # or\n"
+            "  export REQUESTS_CA_BUNDLE=/path/to/your/dod_ca_bundle.pem\n\n"
+            "Use the bundle path required by your environment.\n"
+        )
+
+    return (
+        "TLS certificate verification failed.\n\n"
+        "Fix: configure Python/requests to use your organization trust bundle.\n"
+        "Common options:\n"
+        "  export SSL_CERT_FILE=/path/to/ca-bundle.pem\n"
+        "  export REQUESTS_CA_BUNDLE=/path/to/ca-bundle.pem\n"
+    )

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

@@ -2,7 +2,7 @@
 name = "cwms-cli"
 repository = "https://github.com/HydrologicEngineeringCenter/cwms-cli"
 
-version = "0.2.1"
+version = "0.3.0"
 
 
 packages = [
@@ -19,13 +19,14 @@ python = "^3.9"
 click = "^8.1.8"
 hecdss  = { version = ">=0.1.24", optional = true }  # Via https://github.com/HydrologicEngineeringCenter/hec-python-library/blob/main/hec/shared.py#L9-10
 cwms-python = { version = ">=0.8.0", optional = true}
+colorama = "^0.4.6"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.2.0"
 isort = "^5.13.2"
 mypy = "^1.9.0"
 pre-commit = "^3.6.2"
-pytest = { version = "^9.0.2", python = ">=3.10" }
+pytest = "^8.3.5"
 #pytest-cov = "^4.1.0"
 #pandas-stubs = "^2.2.1.240316"
 yamlfix = "^1.16.0"
@@ -44,4 +45,4 @@ explicit_start = false
 preserve_quotes = true
 
 [tool.poetry.scripts]
-cwms-cli = "cwmscli.__main__:cli"
+cwms-cli = "cwmscli.__main__:main"

cwms_cli-0.2.1/cwmscli/__init__.py

@@ -1,14 +0,0 @@
-import logging as lg
-
-from cwmscli import load
-
-# create logging for logging
-logging = lg.getLogger()
-if logging.hasHandlers():
-    logging.handlers.clear()
-handler = lg.StreamHandler()
-formatter = lg.Formatter("%(asctime)s;%(levelname)s;%(message)s", "%Y-%m-%d %H:%M:%S")
-handler.setFormatter(formatter)
-logging.addHandler(handler)
-logging.setLevel(lg.INFO)
-logging.propagate = False

cwms_cli-0.2.1/cwmscli/__main__.py

@@ -1,17 +0,0 @@
-import click
-
-from cwmscli.commands import commands_cwms
-from cwmscli.load import __main__ as load
-from cwmscli.usgs import usgs_group
-
-
-@click.group()
-def cli():
-    pass
-
-
-cli.add_command(usgs_group, name="usgs")
-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)