bigeye-cli 0.8.5__tar.gz → 0.8.7__tar.gz

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bigeye-cli
-Version: 0.8.5
+Version: 0.8.7
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
 Home-page: https://docs.bigeye.com/docs
 License: Proprietary
@@ -18,7 +18,7 @@ Requires-Dist: rich (>=14.1.0,<15.0.0)
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.8.5
+Version: 0.8.7
 ## Installation
 
 **Setting up your local/build environment**  
@@ -631,7 +631,7 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-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.
 * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
 * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
-* `-nq, --no_queue`: Don&#x27;t submit to queue: True or False. [DEPRECATED]
+* `-nq, --no_queue`: Don&#x27;t submit to queue: True or False. [DEPRECATED — ignored; will be removed in 1.0]
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
 * `-n, --namespace TEXT`: The namespace for the deployment. (This must match across all files or namespace should not be set in files)
@@ -658,7 +658,7 @@ $ bigeye bigconfig apply [OPTIONS]
 * `-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.
 * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
 * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
-* `-nq, --no_queue`: Don&#x27;t submit to queue: True or False. [DEPRECATED]
+* `-nq, --no_queue`: Don&#x27;t submit to queue: True or False. [DEPRECATED — ignored; will be removed in 1.0]
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
 * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
@@ -1909,8 +1909,7 @@ $ bigeye lineage create-node [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
+* `-en, --entity_name TEXT`: The fully qualified table name  [required]
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage delete-node`
@@ -1928,8 +1927,7 @@ $ bigeye lineage delete-node [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
+* `-en, --entity_name TEXT`: The fully qualified table name  [required]
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage create-relation`
@@ -1967,9 +1965,8 @@ $ bigeye lineage delete-relation [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook
+* `-en, --entity_name TEXT`: The fully qualified table name
 * `-rid, --relation_id INTEGER`: The relationship ID to delete  [default: 0]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage infer-relations`

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.8.5
+Version: 0.8.7
 ## Installation
 
 **Setting up your local/build environment**  
@@ -612,7 +612,7 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-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.
 * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
 * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
-* `-nq, --no_queue`: Don't submit to queue: True or False. [DEPRECATED]
+* `-nq, --no_queue`: Don't submit to queue: True or False. [DEPRECATED — ignored; will be removed in 1.0]
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
 * `-n, --namespace TEXT`: The namespace for the deployment. (This must match across all files or namespace should not be set in files)
@@ -639,7 +639,7 @@ $ bigeye bigconfig apply [OPTIONS]
 * `-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.
 * `-psn, --purge_source_name TEXT`: List of source names to purge  E.g. -psn source_1 -psn source_2.
 * `-purge_all, --purge_all_sources`: Purge all sources: True or False.
-* `-nq, --no_queue`: Don't submit to queue: True or False. [DEPRECATED]
+* `-nq, --no_queue`: Don't submit to queue: True or False. [DEPRECATED — ignored; will be removed in 1.0]
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
 * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
@@ -1890,8 +1890,7 @@ $ bigeye lineage create-node [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
+* `-en, --entity_name TEXT`: The fully qualified table name  [required]
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage delete-node`
@@ -1909,8 +1908,7 @@ $ bigeye lineage delete-node [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook  [required]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
+* `-en, --entity_name TEXT`: The fully qualified table name  [required]
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage create-relation`
@@ -1948,9 +1946,8 @@ $ bigeye lineage delete-relation [OPTIONS]
 * `-b, --bigeye_conf TEXT`: Bigeye Credential File Path  [env var: BIGEYE_API_CRED_FILE]
 * `-c, --config_file TEXT`: Bigeye CLI Configuration File Path  [env var: BIGEYE_API_CONFIG_FILE]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
-* `-en, --entity_name TEXT`: The fully qualified table name or name of the tableau workbook
+* `-en, --entity_name TEXT`: The fully qualified table name
 * `-rid, --relation_id INTEGER`: The relationship ID to delete  [default: 0]
-* `-in, --int_name TEXT`: The name of the BI connection (required for entities outside of Bigeye)
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage infer-relations`

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/bigconfig/bigconfig_commands.py

@@ -19,6 +19,7 @@ from bigeye_sdk.generated.com.bigeye.models.generated import (
 )
 from bigeye_sdk.model.big_config import BigConfig
 from bigeye_sdk.model.protobuf_message_facade import SimpleCollection
+from bigeye_sdk.decorators.deprecation import build_deprecation_message
 from bigeye_sdk.log import get_logger
 
 log = get_logger(__file__)
@@ -74,9 +75,10 @@ def plan(
         )
     else:
         if no_queue:
-            log.warning(
-                "The --no_queue flag is deprecated. The option will be ignored now and removed in a later version."
-            )
+            log.warning(build_deprecation_message(
+                "The --no_queue flag",
+                details="The option is ignored and will be removed."
+            ))
         report = mc.execute_bigconfig(
             input_path=input_path,
             output_path=output_path,
@@ -130,9 +132,10 @@ def apply(
         )
     else:
         if no_queue:
-            log.warning(
-                "The --no_queue flag is deprecated. The option will be ignored now and removed in a later version."
-            )
+            log.warning(build_deprecation_message(
+                "The --no_queue flag",
+                details="The option is ignored and will be removed."
+            ))
         mc.execute_bigconfig(
             input_path=input_path,
             output_path=output_path,

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/bigconfig/bigconfig_options.py

@@ -31,7 +31,7 @@ no_queue: bool = typer.Option(
     False
     , "--no_queue"
     , "-nq"
-    , help="Don't submit to queue: True or False. [DEPRECATED]"
+    , help="Don't submit to queue: True or False. [DEPRECATED — ignored; will be removed in 1.0]"
 )
 recursive: bool = typer.Option(
     False

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/catalog/catalog_commands.py

@@ -50,6 +50,7 @@ from bigeye_sdk.generated.com.bigeye.models.generated import (
     OwnableType,
     SchemaChange,
 )
+from bigeye_sdk.decorators.deprecation import build_deprecation_message
 from bigeye_sdk.log import get_logger
 from bigeye_cli.functions import (
     write_metric_info,
@@ -98,6 +99,7 @@ def regen_autometrics(
         ),
 ):
     """Regenerates Autometrics by warehouse id OR warehouse id and list of schema names OR list of table ids."""
+    log.warning(build_deprecation_message("bigeye catalog regen_autometrics"))
     client = cli_client_factory(bigeye_conf, config_file, workspace)
 
     if not table_ids:
@@ -657,6 +659,7 @@ def set_metric_time(
 ):
     """Sets metric times from a list of possible metric column names.  Can set for whole warehouse or for a list of
     table IDs."""
+    log.warning(build_deprecation_message("bigeye catalog set_metric_time", "rct_overrides at the metric level"))
     client = cli_client_factory(bigeye_conf, config_file, workspace)
 
     if warehouse_id and table_ids:
@@ -691,6 +694,7 @@ def unset_metric_time(
         ),
 ):
     """Unsets metric times for whole warehouse or for a list og table IDs."""
+    log.warning(build_deprecation_message("bigeye catalog unset_metric_time", "rct_overrides at the metric level"))
     client = cli_client_factory(bigeye_conf, config_file, workspace)
 
     if warehouse_id and table_ids:
@@ -941,11 +945,11 @@ def upsert_virtual_table(
     ]
 
     if update:
-        log.warning(
-            f"The update flag has been deprecated. This command will now scan for virtual tables that match the"
-            f"given source and virtual table names. If one is found, the virtual table will be updated, "
-            f"else the virtual table will be created."
-        )
+        log.warning(build_deprecation_message(
+            "The --update flag",
+            details="This command now scans for virtual tables matching the given source and virtual table "
+                    "names; if one is found it is updated, otherwise it is created.",
+        ))
 
     table: Table = next(
         (

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/catalog/custom_repo_commands.py

@@ -7,16 +7,13 @@ import typer
 from bigeye_cli import global_options
 from bigeye_cli.functions import cli_client_factory
 from bigeye_sdk.controller.custom_repository_controller import CustomRepositoryController
-from bigeye_sdk.generated.com.bigeye.models.generated import DataNodeType
 from bigeye_sdk.log import get_logger
 from bigeye_sdk.model.custom_repository_excel import (
     SHEET_EDGES,
     CustomRepoWorkbook,
-    EdgeEndpointType,
     WorkbookValidationError,
     build_config,
     iter_path_endpoints,
-    parse_catalog_path,
     read_workbook,
     validate_workbook,
     write_workbook,
@@ -79,14 +76,7 @@ def _resolve_paths(
     # resolution below is a cache lookup rather than several API calls each.
     controller.warm_warehouse_cache(endpoints)
     for endpoint_type, value in endpoints:
-        if endpoint_type == EdgeEndpointType.CUSTOM.value:
-            # CUSTOM endpoints are catalog paths into custom-repository nodes; the
-            # type filter keeps the search off same-named warehouse/MetaCenter nodes.
-            matches = controller.resolve_catalog_path(
-                parse_catalog_path(value), search_type=DataNodeType.DATA_NODE_TYPE_CUSTOM
-            )
-        else:
-            matches = controller.resolve_warehouse_fqn(endpoint_type, value)
+        matches = controller.resolve_edge_endpoint(endpoint_type, value)
         if not matches:
             errors.append(
                 WorkbookValidationError(

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/enums.py

@@ -1,10 +1,14 @@
 import enum
-from typing import List
+from typing import Any, List
 
 from bigeye_cli.model.github_report import GitHubReport
+from bigeye_sdk.decorators.deprecation import warn_deprecated
 from bigeye_sdk.generated.com.bigeye.models.generated import PredefinedMetric, PredefinedMetricName
 
-OPS_METRICS: List[PredefinedMetric] = [
+# Deprecated, scheduled for removal in Bigeye 1.0. This constant is unused within the
+# CLI/SDK; it is served via module __getattr__ (PEP 562) so any external access emits a
+# DeprecationWarning while internal code (which never references it) stays silent.
+_OPS_METRICS: List[PredefinedMetric] = [
     PredefinedMetric(metric_name=PredefinedMetricName.PERCENT_NULL),
     PredefinedMetric(metric_name=PredefinedMetricName.COUNT_NULL),
     PredefinedMetric(metric_name=PredefinedMetricName.PERCENT_EMPTY_STRING),
@@ -18,6 +22,13 @@ OPS_METRICS: List[PredefinedMetric] = [
 ]
 
 
+def __getattr__(name: str) -> Any:
+    if name == "OPS_METRICS":
+        warn_deprecated(subject="OPS_METRICS")
+        return _OPS_METRICS
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
 class MetricFileType(enum.Enum):
     SIMPLE = 'SIMPLE'
     FULL = 'FULL'

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/lineage/lineage_commands.py

@@ -44,19 +44,13 @@ def create_node(
             ...
             , "--entity_name"
             , "-en"
-            , help="The fully qualified table name or name of the tableau workbook"
-        ),
-        integration_name: Optional[str] = typer.Option(
-            None
-            , "--int_name"
-            , "-in"
-            , help="The name of the BI connection (required for entities outside of Bigeye)"
+            , help="The fully qualified table name"
         )
 ):
     """Create a lineage node for an entity"""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
     lineage_controller = LineageController(client)
-    node = lineage_controller.create_node_by_name(entity_name=entity_name, integration_name=integration_name)
+    node = lineage_controller.create_node_by_name(entity_name=entity_name)
     log.info(f"Node created:\n\tID: {node.id}\n\tname: {node.node_name}")
 
 
@@ -69,19 +63,13 @@ def delete_node(
             ...
             , "--entity_name"
             , "-en"
-            , help="The fully qualified table name or name of the tableau workbook"
-        ),
-        integration_name: Optional[str] = typer.Option(
-            None
-            , "--int_name"
-            , "-in"
-            , help="The name of the BI connection (required for entities outside of Bigeye)"
+            , help="The fully qualified table name"
         )
 ):
     """Delete a lineage node for an entity"""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
     lineage_controller = LineageController(client)
-    lineage_controller.delete_node_by_name(entity_name=entity_name, integration_name=integration_name)
+    lineage_controller.delete_node_by_name(entity_name=entity_name)
 
 
 @app.command()
@@ -139,19 +127,13 @@ def delete_relation(
             None
             , "--entity_name"
             , "-en"
-            , help="The fully qualified table name or name of the tableau workbook"
+            , help="The fully qualified table name"
         ),
         relationship_id: Optional[int] = typer.Option(
             0
             , "--relation_id"
             , "-rid"
             , help="The relationship ID to delete"
-        ),
-        integration_name: Optional[str] = typer.Option(
-            None
-            , "--int_name"
-            , "-in"
-            , help="The name of the BI connection (required for entities outside of Bigeye)"
         )
 ):
     """Deletes a single relationship based on relation ID or all relationships for a node by name."""
@@ -163,7 +145,7 @@ def delete_relation(
     elif relationship_id:
         client.delete_lineage_relationship(relationship_id=relationship_id)
     else:
-        lineage_controller.delete_relationships_by_name(entity_name=entity_name, integration_name=integration_name)
+        lineage_controller.delete_relationships_by_name(entity_name=entity_name)
 
 
 @app.command()

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/bigeye_cli/metric/metric_commands.py

@@ -1,5 +1,4 @@
 
-import warnings
 from collections import defaultdict
 from os import listdir
 from os.path import join, isfile
@@ -29,6 +28,7 @@ from bigeye_sdk.model.protobuf_enum_facade import (
     SimpleFieldType,
 )
 
+from bigeye_sdk.decorators.deprecation import build_deprecation_message
 from bigeye_sdk.log import get_logger
 from bigeye_cli.functions import (
     write_metric_info,
@@ -182,11 +182,10 @@ def upsert_from_path(
     c_ix: Dict[str, List[int]] = defaultdict(list)
 
     if set_row_creation_time:
-        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
-        )
+        log.warning(build_deprecation_message(
+            "--set_row_creation_time",
+            details="Row creation time is managed in the metricConfiguration via the 'rctOverride' field.",
+        ))
     named_schedules = {s.name.strip().lower(): s.id for s in client.get_named_schedule().named_schedules}
 
     for m in mil.metrics:

{bigeye_cli-0.8.5 → bigeye_cli-0.8.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.8.5"
+version = "0.8.7"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]