bigeye-cli 0.3.63__tar.gz → 0.3.65__tar.gz

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bigeye-cli
-Version: 0.3.63
+Version: 0.3.65
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
 Home-page: https://docs.bigeye.com/docs
 License: Proprietary
@@ -12,7 +12,6 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: PyGithub (>=1.57,<2.0)
 Requires-Dist: bigeye-sdk (>=0.4.84,<0.5.0)
 Requires-Dist: click (>=8.0.4,<9.0.0)
@@ -20,7 +19,7 @@ Requires-Dist: rich (>=12.4.4,<13.0.0)
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.3.55
+Version: 0.3.65
 ## Installation
 
 **Setting up your local/build environment**  
@@ -192,9 +191,7 @@ password = fakepassword1234
 
 **Note:** Most use cases will only require you to have a single `DEFAULT` credential that all workspaces can utilize. Running the `bigeye configure -w <workspace-name>` command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if the `use_default_credential` setting is set to False in the configuration of the corresponding workspace.
 
-# CLI Documentation
-
-# `bigeye configure`
+# CLI Documentation# `bigeye configure`
 
 Configuration Commands for Bigeye CLI
 
@@ -235,7 +232,6 @@ $ bigeye configure get [OPTIONS] [SETTING_KEY]
 
 **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]
 * `--help`: Show this message and exit.
@@ -254,7 +250,6 @@ $ bigeye configure list [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]
 * `--help`: Show this message and exit.
 
 ## `bigeye configure set`
@@ -274,7 +269,6 @@ $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
 
 **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]
 * `--help`: Show this message and exit.
@@ -308,6 +302,7 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `schedule-all-metrics`: Schedule all metrics in a workspace.
 * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
 * `upsert-group`: Create or update a group.
+* `upsert-named-schedule`: Create a named, cron based schedule
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -534,6 +529,25 @@ $ bigeye workspace upsert-group [OPTIONS]
 * `-id, --group_id INTEGER`: Group ID.
 * `--help`: Show this message and exit.
 
+## `bigeye workspace upsert-named-schedule`
+
+Create a named, cron based schedule
+
+**Usage**:
+
+```console
+$ bigeye workspace upsert-named-schedule [OPTIONS]
+```
+
+**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]
+* `-sn, --name TEXT`: The user defined name of the schedule  [required]
+* `-c, --cron TEXT`: The cron string to define the schedule  [required]
+* `--help`: Show this message and exit.
+
 ## `bigeye workspace upsert-workspace`
 
 Create or update a workspace.
@@ -645,6 +659,7 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-nq, --no_queue`: Don't submit to queue: True or False.
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
+* `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`
@@ -672,7 +687,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `delete-source`: Delete a source from specified Bigeye...
 * `delete-template`: Delete a template.
 * `delete-virtual-table`: Delete a virtual table.
-* `deploy-all-autometrics`: Deploys all Autometrics to specified...
 * `get-all-metric-templates`: Retrieve all metric templates and output...
 * `get-metric-info`: Outputs metric info to a file.
 * `get-metric-queries`: Gets the debug queries for all metrics by...
@@ -684,6 +698,7 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `run-metrics`: Runs metrics by warehouse id, schema...
 * `schedule-all-metrics`: Updates schedule for all metrics in a...
 * `set-metric-time`: Sets metric times from a list of possible...
+* `track-schema-changes`: Track schema changes for sources on demand...
 * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
 * `unset-metric-time`: Unsets metric times for whole warehouse or...
 * `upsert-template`: Create or update a template for a source.
@@ -771,7 +786,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
 * `-wid, --warehouse_id INTEGER`: Warehouse ID
 * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
 * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA, VOLUME_DATA
+* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA, VOLUME_DATA, COUNT_VALUE_IN_LIST
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -829,29 +844,6 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
 * `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
 * `--help`: Show this message and exit.
 
-## `bigeye catalog deploy-all-autometrics`
-
-Deploys all Autometrics to specified warehouse OR warehouse and list of schema names OR warehouse and list of
-table ids.
-
-**Usage**:
-
-```console
-$ bigeye catalog deploy-all-autometrics [OPTIONS]
-```
-
-**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]
-* `-wid, --warehouse_id INTEGER`: Deploy autometrics to all tables in warehouse.
-* `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
-* `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-lbd, --lookback_days INTEGER`: Look back days for the metrics.  [default: 7]
-* `--ops_only`: Deploy only operational metrics  [default: True]
-* `--help`: Show this message and exit.
-
 ## `bigeye catalog get-all-metric-templates`
 
 Retrieve all metric templates and output to a file.
@@ -1094,6 +1086,32 @@ $ bigeye catalog set-metric-time [OPTIONS]
 * `-r, --replace`: replace metric times if already present on tables?  Default is false.
 * `--help`: Show this message and exit.
 
+## `bigeye catalog track-schema-changes`
+
+Track schema changes for sources on demand or every n hour(s) and notify specified channels.
+Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
+
+**Usage**:
+
+```console
+$ bigeye catalog track-schema-changes [OPTIONS]
+```
+
+**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]
+* `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
+* `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd)  [default: 1970-01-01]
+* `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once)  [default: 0]
+* `-ct, --change_type [CREATED|DELETED|TYPE_CHANGED]`: The types of changes to track; i.e additions, changes, deletions. (None will track all types)  [default: DELETED, CREATED, TYPE_CHANGED]
+* `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
+* `-smtp, --server TEXT`: The server to send emails.
+* `-p, --port INTEGER`: The server port to send emails.  [default: 587]
+* `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
+* `--help`: Show this message and exit.
+
 ## `bigeye catalog unschedule-all-metrics`
 
 Unschedule all metrics by warehouse, schema or tables.
@@ -1148,12 +1166,13 @@ $ bigeye catalog upsert-template [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]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
-* `-tn, --name TEXT`: The user defined name of the template  [required]
-* `-tb, --body TEXT`: The string to define the template  [required]
-* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN  [required]
-* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING  [required]
+* `-sn, --source_name TEXT`: The name of the source where the template will be defined
+* `-tn, --name TEXT`: The user defined name of the template
+* `-tb, --body TEXT`: The string to define the template
+* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
+* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
 * `-id, --template_id INTEGER`: The template ID (Only required when updating a template).  [default: 0]
+* `-tf, --template_file TEXT`: A file containing a template definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog upsert-virtual-table`
@@ -1222,7 +1241,7 @@ $ bigeye metric dbt-tests-to-metrics [OPTIONS]
 * `-sf, --schema_file TEXT`: The path to the dbt schema file  [required]
 * `-auto, --use_auto`: Use autothresholds over default constant
 * `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
-* `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true.  [default: /Users/cmacdonald/Projects/semantic-data-platform/bigeye-integrations/bigeye-cli]
+* `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true.  [default: /home/runner/work/semantic-data-platform/semantic-data-platform/bigeye-integrations/bigeye-cli]
 * `--help`: Show this message and exit.
 
 ## `bigeye metric get-info`
@@ -1511,7 +1530,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-source, --source_selector TEXT`: The pattern of tables in the source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.  [required]
 * `-target, --target_selector TEXT`: The pattern of tables in the target to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.  [required]
-* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: MatchType.STRICT]
+* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1720,6 +1739,7 @@ $ bigeye lineage create-relation [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-up, --upstream TEXT`: The fully qualified table name  [required]
 * `-down, --downstream TEXT`: The fully qualified table name  [required]
+* `-co, --column_overrides TEXT`: The list of column overrides, formatted as upstream_column_name:downstream_column_name
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage delete-node`
@@ -1778,7 +1798,9 @@ $ bigeye lineage infer-relations [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-upstream, --upstream_selector TEXT`: The pattern of tables in the upstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.
 * `-downstream, --downstream_selector TEXT`: The pattern of tables in the downstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.
-* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: MatchType.STRICT]
+* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
+* `-lc, --lineage_conf TEXT`: The path to a Simple Lineage configuration file.
+* `-purge, --purge_lineage`: Purge all lineage edges.
 * `--help`: Show this message and exit.
 
 

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.3.55
+Version: 0.3.65
 ## Installation
 
 **Setting up your local/build environment**  
@@ -171,9 +171,7 @@ password = fakepassword1234
 
 **Note:** Most use cases will only require you to have a single `DEFAULT` credential that all workspaces can utilize. Running the `bigeye configure -w <workspace-name>` command for a non-default workspace will prompt you to inherit the credentials from default or create a new set of credentials. A workspace credential is only required if the `use_default_credential` setting is set to False in the configuration of the corresponding workspace.
 
-# CLI Documentation
-
-# `bigeye configure`
+# CLI Documentation# `bigeye configure`
 
 Configuration Commands for Bigeye CLI
 
@@ -214,7 +212,6 @@ $ bigeye configure get [OPTIONS] [SETTING_KEY]
 
 **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]
 * `--help`: Show this message and exit.
@@ -233,7 +230,6 @@ $ bigeye configure list [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]
 * `--help`: Show this message and exit.
 
 ## `bigeye configure set`
@@ -253,7 +249,6 @@ $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
 
 **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]
 * `--help`: Show this message and exit.
@@ -287,6 +282,7 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `schedule-all-metrics`: Schedule all metrics in a workspace.
 * `unschedule-all-metrics`: Unschedule all metrics in a workspace.
 * `upsert-group`: Create or update a group.
+* `upsert-named-schedule`: Create a named, cron based schedule
 * `upsert-workspace`: Create or update a workspace.
 
 ## `bigeye workspace create-named-schedule`
@@ -513,6 +509,25 @@ $ bigeye workspace upsert-group [OPTIONS]
 * `-id, --group_id INTEGER`: Group ID.
 * `--help`: Show this message and exit.
 
+## `bigeye workspace upsert-named-schedule`
+
+Create a named, cron based schedule
+
+**Usage**:
+
+```console
+$ bigeye workspace upsert-named-schedule [OPTIONS]
+```
+
+**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]
+* `-sn, --name TEXT`: The user defined name of the schedule  [required]
+* `-c, --cron TEXT`: The cron string to define the schedule  [required]
+* `--help`: Show this message and exit.
+
 ## `bigeye workspace upsert-workspace`
 
 Create or update a workspace.
@@ -624,6 +639,7 @@ $ bigeye bigconfig plan [OPTIONS]
 * `-nq, --no_queue`: Don't submit to queue: True or False.
 * `-r, --recursive`: Search all input directories recursively.
 * `-strict, --strict_mode`: API errors cause an exception if True. (Validation errors still cause an exception)
+* `-cicd, --cicd_report`: Add the report to a pull request. (Github only)
 * `--help`: Show this message and exit.
 
 # `bigeye catalog`
@@ -651,7 +667,6 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `delete-source`: Delete a source from specified Bigeye...
 * `delete-template`: Delete a template.
 * `delete-virtual-table`: Delete a virtual table.
-* `deploy-all-autometrics`: Deploys all Autometrics to specified...
 * `get-all-metric-templates`: Retrieve all metric templates and output...
 * `get-metric-info`: Outputs metric info to a file.
 * `get-metric-queries`: Gets the debug queries for all metrics by...
@@ -663,6 +678,7 @@ $ bigeye catalog [OPTIONS] COMMAND [ARGS]...
 * `run-metrics`: Runs metrics by warehouse id, schema...
 * `schedule-all-metrics`: Updates schedule for all metrics in a...
 * `set-metric-time`: Sets metric times from a list of possible...
+* `track-schema-changes`: Track schema changes for sources on demand...
 * `unschedule-all-metrics`: Unschedule all metrics by warehouse,...
 * `unset-metric-time`: Unsets metric times for whole warehouse or...
 * `upsert-template`: Create or update a template for a source.
@@ -750,7 +766,7 @@ $ bigeye catalog delete-metrics [OPTIONS]
 * `-wid, --warehouse_id INTEGER`: Warehouse ID
 * `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
 * `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA, VOLUME_DATA
+* `-m, --metric_type TEXT`: Delete by name of the metric type.UNDEFINED_PREDEFINED_METRIC_NAME, PERCENT_NULL, COUNT_NULL, PERCENT_EMPTY_STRING, COUNT_EMPTY_STRING, PERCENT_UNIQUE, PERCENT_VALUE_IN_LIST, AVERAGE, MIN, MAX, SUM, COUNT_ROWS, COUNT_DISTINCT, HOURS_SINCE_MAX_DATE, HOURS_SINCE_MAX_TIMESTAMP, COUNT_TRUE, PERCENT_TRUE, COUNT_FALSE, PERCENT_FALSE, COUNT_USA_PHONE, PERCENT_USA_PHONE, COUNT_USA_ZIP_CODE, PERCENT_USA_ZIP_CODE, PERCENT_UUID, COUNT_TIMESTAMP_STRING, PERCENT_TIMESTAMP_STRING, COUNT_DUPLICATES, COUNT_USA_STATE_CODE, PERCENT_USA_STATE_CODE, VARIANCE, SKEW, KURTOSIS, GEOMETRIC_MEAN, HARMONIC_MEAN, COUNT_UUID, COUNT_CUSIP, PERCENT_CUSIP, COUNT_SEDOL, PERCENT_SEDOL, COUNT_ISIN, PERCENT_ISIN, COUNT_LEI, PERCENT_LEI, COUNT_FIGI, PERCENT_FIGI, COUNT_PERM_ID, PERCENT_PERM_ID, COUNT_NAN, PERCENT_NAN, COUNT_LONGITUDE, PERCENT_LONGITUDE, COUNT_LATITUDE, PERCENT_LATITUDE, COUNT_NOT_IN_FUTURE, PERCENT_NOT_IN_FUTURE, COUNT_DATE_NOT_IN_FUTURE, PERCENT_DATE_NOT_IN_FUTURE, MEDIAN, PERCENTILE, COUNT_NOT_NULL, STRING_LENGTH_AVERAGE, STRING_LENGTH_MIN, STRING_LENGTH_MAX, COUNT_SSN, PERCENT_SSN, COUNT_EMAIL, PERCENT_EMAIL, ROWS_INSERTED, HOURS_SINCE_LAST_LOAD, COUNT_READ_QUERIES, PERCENT_NOT_NULL, FRESHNESS, VOLUME, FRESHNESS_DATA, VOLUME_DATA, COUNT_VALUE_IN_LIST
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog delete-source`
@@ -808,29 +824,6 @@ $ bigeye catalog delete-virtual-table [OPTIONS]
 * `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
 * `--help`: Show this message and exit.
 
-## `bigeye catalog deploy-all-autometrics`
-
-Deploys all Autometrics to specified warehouse OR warehouse and list of schema names OR warehouse and list of
-table ids.
-
-**Usage**:
-
-```console
-$ bigeye catalog deploy-all-autometrics [OPTIONS]
-```
-
-**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]
-* `-wid, --warehouse_id INTEGER`: Deploy autometrics to all tables in warehouse.
-* `-sn, --schema_name TEXT`: List of Schema Names.  E.g. -sn schema_1 -sn schema_2.
-* `-tid, --table_id INTEGER`: Table IDs.  E.g. -tid 123 -tid 124
-* `-lbd, --lookback_days INTEGER`: Look back days for the metrics.  [default: 7]
-* `--ops_only`: Deploy only operational metrics  [default: True]
-* `--help`: Show this message and exit.
-
 ## `bigeye catalog get-all-metric-templates`
 
 Retrieve all metric templates and output to a file.
@@ -1073,6 +1066,32 @@ $ bigeye catalog set-metric-time [OPTIONS]
 * `-r, --replace`: replace metric times if already present on tables?  Default is false.
 * `--help`: Show this message and exit.
 
+## `bigeye catalog track-schema-changes`
+
+Track schema changes for sources on demand or every n hour(s) and notify specified channels.
+Environment variables SMTP_USER and SMTP_PASSWORD MUST be set if using email notification.
+
+**Usage**:
+
+```console
+$ bigeye catalog track-schema-changes [OPTIONS]
+```
+
+**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]
+* `-src, --source TEXT`: A list of source names to track. (None will track changes from all sources)
+* `-s, --since TEXT`: Track schema changes from this date. (Formatted as yyyy-MM-dd)  [default: 1970-01-01]
+* `-f, --frequency INTEGER`: Every n hours to check for schema changes. (None will only run the check once)  [default: 0]
+* `-ct, --change_type [CREATED|DELETED|TYPE_CHANGED]`: The types of changes to track; i.e additions, changes, deletions. (None will track all types)  [default: DELETED, CREATED, TYPE_CHANGED]
+* `-nc, --channel TEXT`: A list of notification channels; e.g. -nc email@mydomain.com -nc #slack_channel -nc https://www.webhook.com
+* `-smtp, --server TEXT`: The server to send emails.
+* `-p, --port INTEGER`: The server port to send emails.  [default: 587]
+* `-t, --token TEXT`: The token to utilize the Slack web client. (Will attempt to use environment variable SLACK_BOT_TOKEN, if not set)
+* `--help`: Show this message and exit.
+
 ## `bigeye catalog unschedule-all-metrics`
 
 Unschedule all metrics by warehouse, schema or tables.
@@ -1127,12 +1146,13 @@ $ bigeye catalog upsert-template [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]
-* `-sn, --source_name TEXT`: The name of the source where the template will be defined  [required]
-* `-tn, --name TEXT`: The user defined name of the template  [required]
-* `-tb, --body TEXT`: The string to define the template  [required]
-* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN  [required]
-* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING  [required]
+* `-sn, --source_name TEXT`: The name of the source where the template will be defined
+* `-tn, --name TEXT`: The user defined name of the template
+* `-tb, --body TEXT`: The string to define the template
+* `-rt, --returns [BOOLEAN|NUMERIC]`: The data type returned by the template; i.e. NUMERIC, BOOLEAN
+* `-p, --params TEXT`: A list of key/value pairs for parameters; ex. -p column=COLUMN_REFERENCE -p table=STRING
 * `-id, --template_id INTEGER`: The template ID (Only required when updating a template).  [default: 0]
+* `-tf, --template_file TEXT`: A file containing a template definition.
 * `--help`: Show this message and exit.
 
 ## `bigeye catalog upsert-virtual-table`
@@ -1201,7 +1221,7 @@ $ bigeye metric dbt-tests-to-metrics [OPTIONS]
 * `-sf, --schema_file TEXT`: The path to the dbt schema file  [required]
 * `-auto, --use_auto`: Use autothresholds over default constant
 * `-bigconfig, --to_bigconfig`: Convert the dbt tests to bigconfig.
-* `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true.  [default: /Users/cmacdonald/Projects/semantic-data-platform/bigeye-integrations/bigeye-cli]
+* `-op, --output_path TEXT`: Output path where bigconfig file will be saved. If no output path is defined then current working directory will be used. Requires --to_bigconfig to be true.  [default: /home/runner/work/semantic-data-platform/semantic-data-platform/bigeye-integrations/bigeye-cli]
 * `--help`: Show this message and exit.
 
 ## `bigeye metric get-info`
@@ -1490,7 +1510,7 @@ $ bigeye deltas suggest-deltas [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-source, --source_selector TEXT`: The pattern of tables in the source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.  [required]
 * `-target, --target_selector TEXT`: The pattern of tables in the target to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.  [required]
-* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: MatchType.STRICT]
+* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
 * `-op, --output_path TEXT`: File to write the delta configuration.  [required]
 * `--help`: Show this message and exit.
 
@@ -1699,6 +1719,7 @@ $ bigeye lineage create-relation [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-up, --upstream TEXT`: The fully qualified table name  [required]
 * `-down, --downstream TEXT`: The fully qualified table name  [required]
+* `-co, --column_overrides TEXT`: The list of column overrides, formatted as upstream_column_name:downstream_column_name
 * `--help`: Show this message and exit.
 
 ## `bigeye lineage delete-node`
@@ -1757,6 +1778,8 @@ $ bigeye lineage infer-relations [OPTIONS]
 * `-w, --workspace TEXT`: Name of the workspace configuration.  [env var: BIGEYE_WORKSPACE; default: DEFAULT]
 * `-upstream, --upstream_selector TEXT`: The pattern of tables in the upstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_1.*.* would be all schemas in source_1.
 * `-downstream, --downstream_selector TEXT`: The pattern of tables in the downstream source to select. Wildcard (*) indicates all tables or all schemas, e.g. source_2.*.* would be all schemas in source_2.
-* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: MatchType.STRICT]
+* `-mt, --match_type [strict|fuzzy]`: How to match tables between the source and target destinations. Strict will only create relations if table names match exactly, Fuzzy will attempt to create relations using a fuzzy match.  [default: strict]
+* `-lc, --lineage_conf TEXT`: The path to a Simple Lineage configuration file.
+* `-purge, --purge_lineage`: Purge all lineage edges.
 * `--help`: Show this message and exit.
 

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/bigeye_cli/catalog/catalog_commands.py

@@ -115,76 +115,6 @@ def regen_autometrics(
         )
 
 
-@app.command()
-def deploy_all_autometrics(
-    bigeye_conf: str = global_options.bigeye_conf,
-    config_file: str = global_options.config_file,
-    workspace: str = global_options.workspace,
-    warehouse_id: int = typer.Option(
-        None,
-        "--warehouse_id",
-        "-wid",
-        help="Deploy autometrics to all tables in warehouse.",
-    ),
-    schema_names: Optional[List[str]] = typer.Option(
-        None,
-        "--schema_name",
-        "-sn",
-        help="List of Schema Names.  E.g. -sn schema_1 -sn schema_2.",
-    ),
-    table_ids: Optional[List[int]] = typer.Option(
-        None, "--table_id", "-tid", help="Table IDs.  E.g. -tid 123 -tid 124"
-    ),
-    lookback_days: int = typer.Option(
-        7, "--lookback_days", "-lbd", help="Look back days for the metrics."
-    ),
-    ops_only: bool = typer.Option(
-        True, "--ops_only", help="Deploy only operational metrics"
-    ),
-):
-    """Deploys all Autometrics to specified warehouse OR warehouse and list of schema names OR warehouse and list of
-    table ids."""
-    # TODO: Add operational metrics only code.
-    log.info(f"Deploying all metrics.")
-    log.info(
-        f"Bigeye API Configuration: {bigeye_conf} | Warehouse ID: {warehouse_id} | Table IDs: {table_ids}"
-    )
-
-    client = cli_client_factory(bigeye_conf, config_file, workspace)
-
-    ms = MetricCreationState.METRIC_CREATION_STATE_SUGGESTED_AUTO
-
-    mil = MetricInfoList()
-
-    if not schema_names:
-        mil = client.get_metric_info_batch_post(
-            warehouse_ids=[warehouse_id],
-            table_ids=table_ids,
-            metric_creation_states=[ms],
-        )
-
-    if schema_names:
-        for sn in schema_names:
-            submil = client.get_metric_info_batch_post(
-                warehouse_ids=[warehouse_id],
-                table_ids=table_ids,
-                metric_creation_states=[ms],
-                schema_name=sn,
-            )
-            mil.metrics.extend(submil.metrics)
-
-    if ops_only:
-        mil.metrics = [
-            m
-            for m in mil.metrics
-            if m.metric_configuration.metric_type.predefined_metric in OPS_METRICS
-        ]
-
-    mids: List[int] = [m.metric_configuration.id for m in mil.metrics]
-
-    client.accept_autometrics(metric_ids=mids, lookback_days=lookback_days)
-
-
 @app.command()
 def delete_metrics(
     bigeye_conf: str = global_options.bigeye_conf,

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/bigeye_cli/configure/configure_commands.py

@@ -2,19 +2,18 @@ import typer
 from rich import print
 from rich.table import Table
 from rich.text import Text
-from typing import List 
+from typing import List
 
-from bigeye_cli.functions import run_enum_menu
+from bigeye_cli.functions import run_enum_menu, get_workspaces_for_user, get_workspace_id_for_user
 from bigeye_cli import global_options
 
 from bigeye_sdk.authentication.enums import AuthConfType, BrowserType
 from bigeye_sdk.authentication.api_authentication import BasicAPIAuth, BrowserAPIAuth, ApiAuth, APIKeyAuth
 from bigeye_sdk.authentication.config import Config
-from bigeye_sdk.client.datawatch_client import get_user_auth
-from bigeye_sdk.generated.com.bigeye.models.generated import Workspace, WorkspaceIdNameAndRole
+from bigeye_sdk.client.datawatch_client import get_user_auth, create_api_key_for_configuration
+from bigeye_sdk.generated.com.bigeye.models.generated import WorkspaceIdNameAndRole
 from bigeye_sdk.exceptions.exceptions import WorkspaceNotSetException
 
-
 from bigeye_sdk.log import get_logger
 
 log = get_logger(__file__)
@@ -29,6 +28,7 @@ def configure(
         config_file: str = global_options.config_file,
         workspace: str = global_options.workspace
 ):
+    required_config = {}
     if ctx.invoked_subcommand is None:
         """Create a default credential for Bigeye CLI."""
         from rich.prompt import Prompt, Confirm
@@ -36,11 +36,11 @@ def configure(
         use_default_credential = True
         if workspace != 'DEFAULT':
             use_default_credential = Confirm.ask("Should this workspace inherit the default credentials?")
-        
+
         # If configuring the default workspace or user specifically asked to enter creds, then perform credential
         # workflow
         if workspace == 'DEFAULT' or not use_default_credential:
-            auth_type = run_enum_menu(enum_clz=AuthConfType, default=AuthConfType.BASIC_AUTH)
+            auth_type = run_enum_menu(enum_clz=AuthConfType, default=AuthConfType.API_KEY_AUTH)
 
             if auth_type == AuthConfType.BROWSER_AUTH:
                 browser_type = run_enum_menu(enum_clz=BrowserType, default=BrowserType.CHROME)
@@ -49,14 +49,45 @@ def configure(
 
                 if browser_type == BrowserType.CHROME:
                     # TODO Could condition on path containing Profile_N directories.
-                    browser_profile_user_name = Prompt.ask("Enter the profile email if logged into Chrome (Default: None)")
+                    browser_profile_user_name = Prompt.ask(
+                        "Enter the profile email if logged into Chrome (Default: None)")
                 base_url = Prompt.ask("Enter the Bigeye URL", default="https://app.bigeye.com")
                 cred = BrowserAPIAuth(browser=browser_type, base_url=base_url,
-                                    browser_profile_user_name=browser_profile_user_name)
+                                      browser_profile_user_name=browser_profile_user_name)
 
             elif auth_type == AuthConfType.API_KEY_AUTH:
                 base_url = Prompt.ask("Enter the Bigeye URL", default="https://app.bigeye.com")
-                api_key = Prompt.ask("Enter the API Key", password=True)
+                username = Prompt.ask("Enter Bigeye username")
+                uses_sso = Confirm.ask("Do you use SSO to access the Bigeye UI?")
+                if not uses_sso:
+                    print(Text(text='\n** Please login to continue **', style='bold green'))
+                    password = Prompt.ask("Enter Bigeye password for username above", password=True)
+                    create_key = Confirm.ask("Would you like to create an API Key?")
+                    basic_cred = BasicAPIAuth(base_url=base_url,
+                                              user=username,
+                                              password=password)
+                    if create_key:
+                        key_name = Prompt.ask("Enter a name for the key")
+                        key_description = Prompt.ask("Enter a description (optional)", default="")
+                        api_key = create_api_key_for_configuration(
+                            cred=basic_cred, name=key_name, description=key_description
+                        )
+                    else:
+                        api_key = Prompt.ask("Enter the API Key", password=True)
+
+                    required_config = get_workspaces_for_user(
+                        cred=basic_cred, workspace=workspace, use_default_credential=use_default_credential
+                    )
+                else:
+                    print(Text(text='\n** Make sure you have created an API key in the UI **', style='bold green'))
+                    api_key = Prompt.ask("Enter the API Key", password=True)
+                    api_auth = APIKeyAuth(base_url=base_url, api_key=api_key)
+                    required_config = get_workspace_id_for_user(cred=api_auth,
+                                                                workspace=workspace,
+                                                                use_default_credential=use_default_credential,
+                                                                bigeye_username=username)
+
+
                 cred = APIKeyAuth(base_url=base_url, api_key=api_key)
 
             else:
@@ -64,50 +95,35 @@ def configure(
                 username = Prompt.ask("Enter the username")
                 password = Prompt.ask("Enter the password", password=True)
                 cred = BasicAPIAuth(base_url=base_url,
-                                    user=username,password=password)
+                                    user=username,
+                                    password=password)
 
-            cred.save_as_file(auth_filename=bigeye_conf,cred=cred,workspace=workspace)
+            cred.save_as_file(auth_filename=bigeye_conf, cred=cred, workspace=workspace)
         # If inheriting from default credential then load default credential
         else:
-            cred = ApiAuth.load(auth_file=bigeye_conf,workspace='DEFAULT')
-        
-        # Only prompt user for workspace ID if they have access to multiple workspaces
-        accessible_workspaces: List[WorkspaceIdNameAndRole] = get_user_auth(cred).workspaces
-        if len(accessible_workspaces) > 1:
-            print(Text(text='\n** WORKSPACE OPTIONS **',style='bold green'))
-            for wk in accessible_workspaces:
-                print(f'{wk.name} - {wk.id}')
-            required_config = {
-                "workspace_id": Prompt.ask(f"Enter Bigeye workspace ID for desired {workspace} configuration", 
-                                            choices=[str(w.id) for w in accessible_workspaces]),
-                "use_default_credential": use_default_credential
-            }
-        elif len(accessible_workspaces) == 1:
-            required_config = {
-                "workspace_id": str(accessible_workspaces[0].id),
-                "use_default_credential": use_default_credential
-            }
-        else:
-            raise WorkspaceNotSetException(f'No workspace access detected. Please check with your Bigeye '
-                                           'administrators to obtain access to a workspace.')
+            cred = ApiAuth.load(auth_file=bigeye_conf, workspace='DEFAULT')
+
+        if not required_config:
+            required_config = get_workspaces_for_user(
+                cred=cred, workspace=workspace, use_default_credential=use_default_credential
+            )
 
         Config(**required_config).upsert_workspace_config(
-                config_file=config_file,
-                workspace=workspace)
-            
+            config_file=config_file,
+            workspace=workspace)
+
 
 @app.command()
 def set(
-        bigeye_conf: str = global_options.bigeye_conf,
         config_file: str = global_options.config_file,
         workspace: str = global_options.workspace,
         setting_key: str = typer.Argument(
             None
-            ,help="The name of the configuration setting."
+            , help="The name of the configuration setting."
         ),
         setting_value: str = typer.Argument(
             None
-            ,help="The value of the configuration setting."
+            , help="The value of the configuration setting."
         )
 ):
     """
@@ -124,18 +140,17 @@ def set(
     else:
         raise typer.BadParameter(
             message=f"No configuration setting named {setting_key} available to modify. "
-            f"Try one of the following: {str.join(', ',config_settings)}"
+                    f"Try one of the following: {str.join(', ', config_settings)}"
         )
 
 
 @app.command()
 def get(
-        bigeye_conf: str = global_options.bigeye_conf,
         config_file: str = global_options.config_file,
         workspace: str = global_options.workspace,
         setting_key: str = typer.Argument(
-        None
-        ,help="The name of the configuration setting."
+            None
+            , help="The name of the configuration setting."
         )
 ):
     """
@@ -147,7 +162,7 @@ def get(
             config_file=config_file,
             setting=setting_key,
             workspace=workspace)
-        
+
         table = Table()
         table.add_column("Workspace", justify="right", style="cyan", no_wrap=True)
         table.add_column("Key", style="magenta")
@@ -157,15 +172,14 @@ def get(
     else:
         raise typer.BadParameter(
             message=f"No configuration setting named {setting_key} available to retrieve. "
-            f"Try one of the following: {str.join(', ',config_settings)}"
+                    f"Try one of the following: {str.join(', ', config_settings)}"
         )
 
 
 @app.command()
 def list(
         bigeye_conf: str = global_options.bigeye_conf,
-        config_file: str = global_options.config_file,
-        workspace: str = global_options.workspace,
+        config_file: str = global_options.config_file
 ):
     """
     List all configured workspaces. 
@@ -197,6 +211,6 @@ def list(
             cred_type = 'Api Key'
         else:
             cred_type = 'Default'
-        table.add_row(key,value.get('workspace_id'),cred_type)
+        table.add_row(key, value.get('workspace_id'), cred_type)
 
     print(table)

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/bigeye_cli/functions.py

@@ -4,9 +4,13 @@ import os
 from typing import List, Dict
 import typer
 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
-from bigeye_sdk.client.datawatch_client import DatawatchClient, datawatch_client_factory, get_user_auth
+from bigeye_sdk.client.datawatch_client import DatawatchClient, datawatch_client_factory, get_user_auth, \
+    get_all_workspaces_for_login, get_allowed_emails_for_workspace
 from bigeye_sdk.functions.metric_functions import get_file_name_for_metric
 from bigeye_sdk.functions.file_functs import create_subdir_if_not_exists, serialize_listdict_to_json_file, \
     write_to_file, serialize_list_to_json_file
@@ -15,7 +19,8 @@ from bigeye_sdk.log import get_logger
 from bigeye_sdk.authentication.api_authentication import ApiAuth
 from bigeye_sdk.authentication.config import Config, WorkspaceConfig
 from bigeye_sdk.exceptions.exceptions import WorkspaceNotSetException, ConfigNotFoundException
-from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList, Table, Issue, MetricTemplate
+from bigeye_sdk.generated.com.bigeye.models.generated import MetricInfoList, Table, Issue, MetricTemplate, \
+    WorkspaceIdNameAndRole
 from bigeye_sdk.model.protobuf_extensions import MetricDebugQueries
 
 log = get_logger(__file__)
@@ -65,8 +70,7 @@ def cli_client_factory(auth_file: str = None, config_file: str = None, workspace
         else:
             auth = ApiAuth.load(auth_file=auth_file, workspace=workspace)
 
-
-        # Attempt to get workspace configuration. If no config created yet, then throw an error 
+        # Attempt to get workspace configuration. If no config created yet, then throw an error
         # and have the user run the bigeye configure command.
         try:
             workspace_config = WorkspaceConfig(**config[workspace])
@@ -214,3 +218,60 @@ def run_enum_menu(enum_clz: enum.EnumMeta, default: StrEnum) -> StrEnum:
             typer.echo(f"Invalid Choice.")
 
     return valid_types[user_chosen_type_ix]
+
+
+def get_workspaces_for_user(cred: ApiAuth, workspace: str, use_default_credential: bool) -> dict:
+    # Only prompt user for workspace ID if they have access to multiple workspaces
+    accessible_workspaces: List[WorkspaceIdNameAndRole] = get_user_auth(auth=cred).workspaces
+    if len(accessible_workspaces) > 1:
+        print(Text(text='\n** WORKSPACE OPTIONS **', style='bold green'))
+        for wk in accessible_workspaces:
+            print(f'{wk.name} - {wk.id}')
+        required_config = {
+            "workspace_id": Prompt.ask(f"Enter Bigeye workspace ID for desired {workspace} configuration",
+                                       choices=[str(w.id) for w in accessible_workspaces]),
+            "use_default_credential": use_default_credential
+        }
+    elif len(accessible_workspaces) == 1:
+        required_config = {
+            "workspace_id": str(accessible_workspaces[0].id),
+            "use_default_credential": use_default_credential
+        }
+    else:
+        raise WorkspaceNotSetException(f'No workspace access detected. Please check with your Bigeye '
+                                       'administrators to obtain access to a workspace.')
+
+    return required_config
+
+
+def verify_email_access_for_workspace(cred: ApiAuth, workspace_id: int, bigeye_username: str) -> int:
+    no_access = f"\nBigeye user {bigeye_username} does not have access to workspace ID {workspace_id}."
+    please_verify = "Please verify you have access or choose another ID from the list above."
+    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_emails = get_allowed_emails_for_workspace(cred=cred, workspace_id=workspace_id)
+    return workspace_id
+
+
+def get_workspace_id_for_user(
+        cred: ApiAuth, workspace: str, use_default_credential: bool, bigeye_username: str
+) -> dict:
+    all_workspaces = get_all_workspaces_for_login(cred=cred)
+    if not all_workspaces:
+        raise WorkspaceNotSetException(f'No workspace access detected. Please check with your Bigeye '
+                                        'administrators to obtain access to a workspace.')
+    print(
+        Text(text='\n** WORKSPACE OPTIONS **\nNOTE: You may not have access to some listed below', style='bold green')
+    )
+    for wk in all_workspaces:
+        print(f'{wk.name} - {wk.id}')
+
+    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, bigeye_username=bigeye_username)
+    return {
+        "workspace_id": workspace_id,
+        "use_default_credential": use_default_credential
+    }

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/bigeye_cli/issues/issue_commands.py

@@ -53,10 +53,10 @@ def get_issues(
             , help="File to write the failed metric configurations to.")
 ):
     """Gets issues and writes info to files."""
-    client = cli_client_factory(bigeye_conf,config_file,workspace)
+    client = cli_client_factory(bigeye_conf, config_file, workspace)
 
     issues = client.get_issues(warehouse_ids=warehouse_ids,
-                               schemas=schemas,
+                               schema_names=schemas,
                                metric_ids=metric_ids,
                                collection_ids=collection_ids,
                                issue_ids=issue_ids)
@@ -96,7 +96,7 @@ def update_issue(
             , help="Used to train Bigeye when closing an issue. Options are TRUE_POSITIVE, FALSE_POSITIVE, EXPECTED.")
 ):
     """Updates an issue in Bigeye and returns the Issue object from the protobuff."""
-    client = cli_client_factory(bigeye_conf,config_file,workspace)
+    client = cli_client_factory(bigeye_conf, config_file, workspace)
 
     client.update_issue(issue_id=issue_id,
                         issue_status=issue_status,

{bigeye_cli-0.3.63 → bigeye_cli-0.3.65}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.3.63"
+version = "0.3.65"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]
@@ -29,7 +29,7 @@ poethepoet = "^0.24.3"
 
 [tool.poe.tasks]
     pre_build = []
-    pre_publish = ["clean"]
+    pre_publish = ["clean", "docgen"]
     post_publish = ["clean"]
 
     [tool.poe.poetry_hooks]