cwms-cli 0.1.1__py3-none-any.whl

cwmscli/usgs/rating_ini_file_import.py

@@ -0,0 +1,130 @@
+import logging
+
+import cwms
+
+rating_types = {
+    "store_corr": {"db_type": "db_corr", "db_disc": "USGS-CORR"},
+    "store_base": {"db_type": "db_base", "db_disc": "USGS-BASE"},
+    "store_exsa": {"db_type": "db_exsa", "db_disc": "USGS-EXSA"},
+}
+
+
+def rating_ini_file_import(api_root, api_key, ini_filename):
+
+    api_key = "apikey " + api_key
+    cwms.api.init_session(api_root=api_root, api_key=api_key)
+
+    logging.info(f"CDA connection: {api_root}")
+    logging.info(f"Opening ini file: {ini_filename}")
+    ini_file = open(ini_filename, "r")
+    lines = ini_file.readlines()
+    ini_file.close()
+
+    params = {}
+    keywords = ["cwms_office", "db_base", "db_exsa", "db_corr", "localid"]
+    rating_errors = []
+    for i in range(len(lines)):
+        line = lines[i][:-1].strip()
+        try:
+            line = line[: line.index("#")].strip()  # strip comments
+        except:
+            pass
+        if not line:
+            continue
+        if "=" in line:
+            fields = line.split("=")
+            if fields[0] in keywords:
+                if fields[0] == "cwms_office":
+                    fields[1] = fields[1].upper()
+                params[fields[0]] = fields[1]
+        else:
+            fields = parse_ini_line(line)
+            if fields[0] in rating_types.keys():
+                rating_db_type = rating_types[fields[0]]["db_type"]
+                if f"$(${rating_db_type})" in fields:
+                    rating_spec = params[rating_db_type].replace(
+                        "\$localid", params["localid"]
+                    )
+                    logging.info(f"Updating rating specification: {rating_spec}")
+                    try:
+                        update_rating_spec(
+                            rating_spec,
+                            params["cwms_office"],
+                            rating_types[fields[0]]["db_disc"],
+                        )
+                        logging.info("SUCCESS: rating specification changes stored")
+                    except:
+                        logging.error(
+                            "ERROR: rating specificataion could not be update"
+                        )
+                        rating_errors.append(
+                            [rating_spec, rating_types[fields[0]]["db_disc"]]
+                        )
+    logging.info(
+        f"ERRORS: The following rating specifications could not be updated {rating_errors}"
+    )
+
+
+def parse_ini_line(line):
+    """
+    Parses a line in the ini_file into fields
+    """
+    if line.find("'") > 0 or line.find('"') > 0:
+        # ---------------------------#
+        # fields with spaces quoted #
+        # ---------------------------#
+        c1 = [c for c in line]
+        escape = False
+        quote = None
+        c2 = []
+        for c in c1:
+            if c == "\\":
+                escape = not escape
+                if not escape:
+                    c2.append(c)
+                continue
+            if c in ('"', "'"):
+                if not quote:
+                    quote = c
+                    continue
+                if c == quote:
+                    quote = None
+                    continue
+            if c.isspace() and quote:
+                c = chr(0)
+            c2.append(c)
+        fields = "".join(c2).split()
+        for i in range(len(fields)):
+            fields[i] = fields[i].replace(chr(0), " ")
+    elif line.find("\t") > 0:
+        # ------------------------------------------------------------#
+        # all fields without spaces separated by tabs (version < 5.0 #
+        # ------------------------------------------------------------#
+        fields = line.split("\t")
+    else:
+        # -----------------------#
+        # no fields with spaces #
+        # -----------------------#
+        fields = line.split()
+    return fields
+
+
+def update_rating_spec(rating_id, office_id, db_disc):
+    rating_spec = cwms.get_rating_spec(rating_id=rating_id, office_id=office_id)
+    data = rating_spec.df
+    data = data.drop("effective-dates", axis=1)
+    logging.info(f"Setting source-agency to USGS")
+    data["source-agency"] = "USGS"
+    logging.info(f"Setting Active, Auto-update, Auto-Activate to True")
+    data["active"] = True
+    data["auto-update"] = True
+    data["auto-activate"] = True
+    if "description" in data.columns:
+        if db_disc not in data.loc[0, "description"]:
+            data["description"] = data["description"] + " " + db_disc
+    else:
+        data["description"] = db_disc
+    disc = data.loc[0, "description"]
+    logging.info(f"Saving specification discription as: {disc}")
+    data_xml = cwms.rating_spec_df_to_xml(data)
+    cwms.store_rating_spec(data=data_xml, fail_if_exists=False)

cwmscli/utils/__init__.py

@@ -0,0 +1,68 @@
+import click
+
+
+def to_uppercase(ctx, param, value):
+    if value is None:
+        return None
+    return value.upper()
+
+
+office_option = click.option(
+    "-o",
+    "--office",
+    required=True,
+    envvar="OFFICE",
+    type=str,
+    callback=to_uppercase,
+    help="Office to grab data for",
+)
+api_root_option = click.option(
+    "-a",
+    "--api_root",
+    required=True,
+    envvar="CDA_API_ROOT",
+    type=str,
+    help="Api Root for CDA. Can be user defined or placed in a env variable CDA_API_ROOT",
+)
+api_coop_root_option = click.option(
+    "--coop",
+    is_flag=True,
+    envvar="CDA_API_COOP_ROOT",
+    type=str,
+    help="Use CDA_API_COOP_ROOT from env",
+)
+
+api_key_option = click.option(
+    "-k",
+    "--api_key",
+    default=None,
+    type=str,
+    envvar="CDA_API_KEY",
+    help="api key for CDA. Can be user defined or place in env variable CDA_API_KEY. one of api_key or api_key_loc are required",
+)
+api_key_loc_option = click.option(
+    "-kl",
+    "--api_key_loc",
+    default=None,
+    type=str,
+    help="file storing Api Key. One of api_key or api_key_loc are required",
+)
+
+
+def get_api_key(api_key: str, api_key_loc: str) -> str:
+    if api_key is not None:
+        return api_key
+    elif api_key_loc is not None:
+        with open(api_key_loc, "r") as f:
+            return f.readline().strip()
+    else:
+        raise Exception(
+            "must add a value to either --api_key(-k) or --api_key_loc(-kl)"
+        )
+
+
+def common_api_options(f):
+    f = office_option(f)
+    f = api_root_option(f)
+    f = api_key_option(f)
+    return f

cwmscli/utils/deps.py

@@ -0,0 +1,102 @@
+import importlib
+import importlib.metadata
+
+import click
+
+
+def requires(*requirements):
+    """
+    Decorator that ensures required Python modules are installed and meet optional minimum version constraints.
+
+    Parameters:
+        *requirements: One or more dictionaries describing a module requirement.
+            Each dictionary may contain the following keys:
+
+            - module (str): The importable module name (e.g., "requests").
+
+            - package (str, optional): The name of the package to install via pip.
+              Use this if the pip install name differs from the import name
+              (e.g., module="cwms", package="cwms-python").
+
+            - version (str, optional): A minimum required version string (e.g., "2.30.0").
+
+            - desc (str, optional): A short description of what the module is or why it's needed.
+              Included in the error message to help users understand the dependency.
+
+            - link (str, optional): A URL pointing to documentation or the package's homepage.
+
+    Example:
+        @requires(
+            {
+                "module": "cwms",
+                "package": "cwms-python",
+                "version": "0.8.0",
+                "desc": "CWMS REST API Python client",
+                "link": "https://github.com/hydrologicengineeringcenter/cwms-python"
+            },
+            {
+                "module": "requests",
+                "version": "2.30.0",
+                "desc": "Required for HTTP API access"
+            }
+        )
+    """
+
+    def decorator(func):
+        def wrapper(*args, **kwargs):
+            missing = []
+            version_issues = []
+
+            for req in requirements:
+                mod = req["module"]
+                pkg = req.get("package", mod)
+                min_version = req.get("version")
+                desc = req.get("desc")
+                link = req.get("link")
+                # Check if the provided requirement is already imported
+                try:
+                    importlib.import_module(mod)
+                except ImportError:
+                    msg = f"- `{mod}` (install: `{pkg}`)"
+                    if desc:
+                        msg += f" — {desc}"
+                    if link:
+                        msg += f" [docs]({link})"
+                    missing.append((msg, pkg))
+                    continue
+                # Confirm the minimum version is met
+                if min_version:
+                    try:
+                        actual_version = importlib.metadata.version(pkg)
+                        if actual_version < min_version:
+                            version_issues.append(
+                                f"- `{pkg}` version `{actual_version}` found, "
+                                f"but `{min_version}` or higher is required"
+                            )
+                    except importlib.metadata.PackageNotFoundError:
+                        version_issues.append(
+                            f"- `{pkg}` is installed but version could not be verified"
+                        )
+            # Build out the error response
+            if missing or version_issues:
+                error_lines = []
+                if missing:
+                    error_lines.append("Missing module(s):")
+                    for msg, _ in missing:
+                        error_lines.append(msg)
+                    install_cmd = "pip install " + " ".join(pkg for _, pkg in missing)
+                    error_lines.append(
+                        f"\nInstall missing packages:\n    {install_cmd}"
+                    )
+
+                if version_issues:
+                    error_lines.append("\nVersion issues:")
+                    error_lines.extend(version_issues)
+
+                raise click.ClickException("\n".join(error_lines))
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator