bigeye-cli 0.5.1__tar.gz → 0.6.0__tar.gz

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bigeye-cli
-Version: 0.5.1
+Version: 0.6.0
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
 Home-page: https://docs.bigeye.com/docs
 License: Proprietary
@@ -13,13 +13,13 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: PyGithub (>=1.59.1,<2.0.0)
-Requires-Dist: bigeye-sdk (>=0.6.0,<0.7.0)
+Requires-Dist: bigeye-sdk (>=0.7.0,<0.8.0)
 Requires-Dist: click (>=8.1.8,<9.0.0)
 Requires-Dist: rich (>=14.1.0,<15.0.0)
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.5.1
+Version: 0.6.0
 ## Installation
 
 **Setting up your local/build environment**  
@@ -681,9 +681,13 @@ $ bigeye bigconfig export [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
 * `-n, --namespace TEXT`: The namespace for the deployment. (This must match across all files or namespace should not be set in files)
+* `-add_auto, --auto_apply_on_indexing`: Adds section to output
+* `-smd_path, --smd-library_path TEXT`: Path to the Saved Metric Definition library.  [default: saved_metric_definitions.yaml]
+* `--smd-only`: Only export metrics to the Saved Metric Definition library
 * `-cid, --collection_id INTEGER`: Collection ID of metrics to be exported.
 * `-tid, --table_id INTEGER`: Table ID of metrics to be exported.
 * `-mid, --metric_id INTEGER`: Metric ID of metrics to be exported.
+* `-v1, --use_v1`: Export metrics using the v1 converter (not recommended).
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.5.1
+Version: 0.6.0
 ## Installation
 
 **Setting up your local/build environment**  
@@ -661,9 +661,13 @@ $ bigeye bigconfig export [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-op, --output_path TEXT`: Output path where reports and fixme files will be saved. If no output path is defined then current working directory will be used.
 * `-n, --namespace TEXT`: The namespace for the deployment. (This must match across all files or namespace should not be set in files)
+* `-add_auto, --auto_apply_on_indexing`: Adds section to output
+* `-smd_path, --smd-library_path TEXT`: Path to the Saved Metric Definition library.  [default: saved_metric_definitions.yaml]
+* `--smd-only`: Only export metrics to the Saved Metric Definition library
 * `-cid, --collection_id INTEGER`: Collection ID of metrics to be exported.
 * `-tid, --table_id INTEGER`: Table ID of metrics to be exported.
 * `-mid, --metric_id INTEGER`: Metric ID of metrics to be exported.
+* `-v1, --use_v1`: Export metrics using the v1 converter (not recommended).
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/bigeye_cli/bigconfig/bigconfig_commands.py

@@ -1,4 +1,6 @@
 import os
+import warnings
+from datetime import datetime
 from pathlib import Path
 from typing import Optional, List
 
@@ -11,7 +13,8 @@ from bigeye_cli.model.github_report import GitHubReport
 from bigeye_sdk.bigconfig_validation.big_config_reports import all_reports
 from bigeye_sdk.controller.metric_controller import MetricController
 from bigeye_sdk.controller.metric_suite_controller import MetricSuiteController
-from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList
+from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList, MetricInfo
+from bigeye_sdk.model.big_config import BigConfig
 from bigeye_sdk.model.protobuf_message_facade import SimpleCollection
 from bigeye_sdk.log import get_logger
 
@@ -145,6 +148,18 @@ def export(
         workspace: str = global_options.workspace,
         output_path: str = bigconfig_options.output_path,
         namespace: Optional[str] = bigconfig_options.namespace,
+        auto_apply_on_indexing: bool = typer.Option(
+            False, "--auto_apply_on_indexing", "-add_auto", help="Adds section to output"
+        ),
+        smd_library_path: str = typer.Option(
+            "saved_metric_definitions.yaml",
+            "--smd-library_path",
+            "-smd_path",
+            help="Path to the Saved Metric Definition library."
+        ),
+        smd_only: bool = typer.Option(
+            False, "--smd-only", help="Only export metrics to the Saved Metric Definition library"
+        ),
         collection_id: int = typer.Option(
             None, "--collection_id", "-cid", help="Collection ID of metrics to be exported."
         ),
@@ -154,13 +169,17 @@ def export(
         metric_ids: List[int] = typer.Option(
             None, "--metric_id", "-mid", help="Metric ID of metrics to be exported."
         ),
+        use_v1: bool = typer.Option(
+            False, "--use_v1", "-v1", help="Export metrics using the v1 converter (not recommended)."
+        )
 ):
     """Exports existing metrics into a valid Bigconfig file."""
 
     client = cli_client_factory(bigeye_conf, config_file, workspace)
-    mc = MetricController(client=client)
+    mc = MetricController(client=client, saved_metric_definitions_path=smd_library_path)
+
     collection: SimpleCollection = SimpleCollection(
-        name="Sample", description="SDK Generated"
+        name=f"CLI Export {datetime.today().strftime('%Y%m%d')}", description="SDK Generated"
     )
 
     final_metric_ids: List[int] = []
@@ -196,22 +215,57 @@ def export(
         if not collection_id:
             collection.name = metrics_from_table[0].metric_metadata.dataset_name
 
-    # Pull metric information
-    metrics: MetricInfoList = client.get_metric_info_batch_post(metric_ids=final_metric_ids)
+    # Pull raw metric info. Converting to protobuf objects complicates default and zero values unnecessarily
+    raw_metrics: List[dict] = client.get_metric_info_batch_post(metric_ids=final_metric_ids,
+                                                                    return_raw_response=True)
 
     if namespace:
-        infos = metrics.metrics
-        metrics = MetricInfoList(metrics=[m for m in infos if m.metric_configuration.bigconfig_namespace == namespace])
+        log.info(f"Filtering metrics that only reside in the namespace: {namespace}")
+        raw_metrics = []
+        # 2025-09-26: Some metric configs don't have the key 'bigconfigNamespace' in them
+        for m in raw_metrics:
+            cfg = m.get("metricConfiguration")
+            if "bigconfigNamespace" in cfg and cfg.get("bigconfigNamespace") == namespace:
+                raw_metrics.append(m)
+        log.info(f"{len(raw_metrics)} metrics found in namespace: {namespace}")
 
     if not output_path:
         output_path = client.config.bigconfig_output_path or Path.cwd()
 
-    if not metrics.metrics:
+    if not raw_metrics:
         raise typer.BadParameter(
             "No metrics found for given arguments. Please check again."
         )
 
-    bigconfig = mc.metric_info_to_bigconfig(metric_info=metrics, collection=collection)
+
+    if not use_v1:
+        mc.infos_to_convert = raw_metrics
+        template_smds = mc.collect_template_smds_from_inputs()
+        mc.write_or_update_smd_library(
+            template_smds_from_inputs=template_smds, auto_apply=auto_apply_on_indexing
+        )
+        typer.secho(
+            f"\nUpdated SMD library at: {mc.saved_metric_def_path}\n", fg="green", bold=True
+        )
+
+        if smd_only:
+            raise typer.Exit(0)
+
+        bc = mc.to_bigconfig_yaml(collection=collection, auto_apply_on_indexing=auto_apply_on_indexing)
+
+        # Dumping **kwargs messes up the formatting
+        bigconfig = BigConfig(type=bc["type"])
+
+        if bc.get("auto_apply_on_indexing", None):
+            bigconfig.auto_apply_on_indexing = True
+        if bc.get("tag_definitions", None):
+            bigconfig.tag_definitions = bc.get("tag_definitions")
+
+        bigconfig.tag_deployments = bc.get("tag_deployments")
+    else:
+        bigconfig = mc.metric_info_to_bigconfig(
+            metric_info=MetricInfoList(metrics=[MetricInfo().from_dict(m) for m in raw_metrics]), collection=collection
+        )
 
     file_name = collection.name.lower().replace(" ", "_")
     output = bigconfig.save(
@@ -220,5 +274,5 @@ def export(
         custom_formatter=bigconfig.format_bigconfig_export,
     )
     typer.secho(
-        f"\nSample bigconfig file generated at: {output}\n", fg="green", bold=True
+        f"\nBigconfig file generated at: {output}\n", fg="green", bold=True
     )

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/bigeye_cli/functions.py

@@ -1,12 +1,12 @@
 import enum
-import json
+
 import os
 from typing import List, Dict, Optional
 import typer
 import yaml
 from rich.prompt import Prompt
 from rich import print
-from rich.table import Table
+
 from rich.text import Text
 
 from bigeye_sdk.class_ext.enum_ext import StrEnum
@@ -199,9 +199,7 @@ def write_metric_templates(output_path: str, metric_templates: List[MetricTempla
     serialize_list_to_json_file(url=url, data=metric_templates)
 
 
-def write_yaml_templates(
-        metric_templates: List[MetricTemplate], output_path: Optional[str] = None, file_name: str = None
-):
+def write_yaml_templates(metric_templates: List[MetricTemplate], output_path: Optional[str] = None):
     if not output_path:
         output_path = os.getcwd()
 
@@ -235,7 +233,7 @@ def run_enum_menu(enum_clz: enum.EnumMeta, default: StrEnum) -> StrEnum:
                 f"Which authorization method would you like to use? "
                 f"(Default: {valid_type_by_type[default]})", default=valid_type_by_type[default])
             )
-        except ValueError as e:
+        except ValueError:
             pass
 
         if user_chosen_type_ix not in valid_types.keys():
@@ -274,7 +272,7 @@ def verify_email_access_for_workspace(cred: ApiAuth, workspace_id: int, bigeye_u
     workspace_emails = get_allowed_emails_for_workspace(cred=cred, workspace_id=workspace_id)
     while bigeye_username.lower() not in workspace_emails:
         print(Text(text=f"{no_access}\n{please_verify}", style='bold yellow'))
-        workspace_id = Prompt.ask(f"Enter Bigeye workspace ID")
+        workspace_id = int(Prompt.ask(f"Enter Bigeye workspace ID"))
         workspace_emails = get_allowed_emails_for_workspace(cred=cred, workspace_id=workspace_id)
     return workspace_id
 
@@ -294,7 +292,7 @@ def get_workspace_id_for_user(
 
     workspace_id = Prompt.ask(f"Enter Bigeye workspace ID for desired {workspace} configuration",
                               choices=[str(w.id) for w in all_workspaces])
-    workspace_id = verify_email_access_for_workspace(cred=cred, workspace_id=workspace_id,
+    workspace_id = verify_email_access_for_workspace(cred=cred, workspace_id=int(workspace_id),
                                                      bigeye_username=bigeye_username)
     return {
         "workspace_id": workspace_id,
@@ -302,9 +300,7 @@ def get_workspace_id_for_user(
     }
 
 
-def write_named_schedules(
-        schedules: List[NamedSchedule], output_path: Optional[str] = None, file_name: Optional[str] = None
-):
+def write_named_schedules(schedules: List[NamedSchedule], output_path: Optional[str] = None):
     if not output_path:
         output_path = os.getcwd()
     else:
@@ -316,9 +312,7 @@ def write_named_schedules(
             yaml.dump({"schedule_name": s.name, "cron": s.cron}, outfile, default_flow_style=False)
 
 
-def write_virtual_tables(
-        virtual_tables: List[VirtualTable], output_path: Optional[str] = None, file_name: Optional[str] = None
-):
+def write_virtual_tables(virtual_tables: List[VirtualTable], output_path: Optional[str] = None):
 
     if not output_path:
         output_path = os.getcwd()

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/bigeye_cli/metric/metric_commands.py

@@ -1,4 +1,5 @@
 # create logger
+import warnings
 from os import listdir
 from os.path import join, isfile
 from typing import List, Dict
@@ -168,22 +169,19 @@ def upsert_from_path(
     table_names = {m.metric_metadata.dataset_name for m in mil.metrics}
     schema_names = {m.metric_metadata.schema_name for m in mil.metrics}
 
-    tables: TableList = client.get_tables(
+    tables: List[Table] = client.get_tables(
         warehouse_id=[target_warehouse_id],
         schema=list(schema_names),
         table_name=list(table_names),
-    )
+    ).tables
 
-    t_ix: Dict[str, Table] = {t.name: t for t in tables.tables}
+    t_ix: Dict[str, Table] = {t.name: t for t in tables}
 
     if set_row_creation_time:
-        rct_cols = {
-            m.metric_metadata.dataset_time_column_name
-            for m in mil.metrics
-            if m.metric_metadata.dataset_time_column_name
-        }
-        client.set_table_metric_times(
-            column_names=rct_cols, table_ids=[t.id for t in tables.tables], replace=True
+        warnings.warn(
+            "set_row_creation_time is deprecated and will be removed in a future version. "
+            "Row creation time is managed in the metricConfiguration with the 'rctOverride' field.",
+            DeprecationWarning
         )
 
     for m in mil.metrics:
@@ -209,6 +207,7 @@ def upsert_from_path(
                 muted_until_epoch_seconds=mc.muted_until_epoch_seconds,
                 name=mc.name,
                 description=mc.description,
+                rct_override=mc.rct_override
             )
 
             if update_collections:

{bigeye_cli-0.5.1 → bigeye_cli-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.5.1"
+version = "0.6.0"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]
@@ -19,7 +19,7 @@ bigeye = "bigeye_cli.__main__:app"
 [tool.poetry.dependencies]
 python = "^3.9.0"
 click = "^8.1.8"
-bigeye-sdk = "^0.6.0"
+bigeye-sdk = "^0.7.0"
 rich = "^14.1.0"
 PyGithub = '^1.59.1'