bigeye-cli 0.3.67__tar.gz → 0.3.69__tar.gz

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: bigeye-cli
-Version: 0.3.67
+Version: 0.3.69
 Summary: Bigeye CLI offers developer tools for maintaining your developer workspace.
-Home-page: https://docs.bigeye.com/docs
 License: Proprietary
 Author: Bigeye
 Author-email: support@bigeye.com
@@ -12,14 +11,17 @@ 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
+Classifier: Programming Language :: Python :: 3.13
 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)
 Requires-Dist: rich (>=12.4.4,<13.0.0)
+Project-URL: Homepage, https://docs.bigeye.com/docs
 Description-Content-Type: text/markdown
 
 # **Bigeye CLI**
-Version: 0.3.67
+Version: 0.3.69
 ## Installation
 
 **Setting up your local/build environment**  
@@ -218,7 +220,7 @@ $ bigeye configure [OPTIONS] COMMAND [ARGS]...
 
 ## `bigeye configure set`
 
-Set any specific configuration settings. 
+Set any specific configuration settings.
 
 **Usage**:
 
@@ -239,7 +241,7 @@ $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
 
 ## `bigeye configure get`
 
-Get any specific configuration settings. 
+Get any specific configuration settings.
 
 **Usage**:
 
@@ -259,7 +261,7 @@ $ bigeye configure get [OPTIONS] [SETTING_KEY]
 
 ## `bigeye configure list`
 
-List all configured workspaces. 
+List all configured workspaces.
 
 **Usage**:
 
@@ -298,7 +300,7 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `delete-named-schedule`: Delete a named schedule.
 * `export-named-schedule`: Export cron schedule to yaml file
 * `invite-user`: Invite a user to a workspace.
-* `edit-user`: Edit an existing user's access to groups.
+* `edit-user`: Edit an existing user&#x27;s access to groups.
 * `delete-user`: Deletes a users account.
 * `upsert-workspace`: Create or update a workspace.
 * `delete-workspace`: Delete a workspace.
@@ -448,7 +450,7 @@ $ bigeye workspace invite-user [OPTIONS]
 
 ## `bigeye workspace edit-user`
 
-Edit an existing user's access to groups.
+Edit an existing user&#x27;s access to groups.
 
 **Usage**:
 
@@ -563,7 +565,7 @@ $ bigeye workspace edit-group-access [OPTIONS]
 * `-name, --group-name TEXT`: Group name.  [required]
 * `-id, --group-id INTEGER`: Group ID.
 * `-wn, --workspace-name TEXT`: List of workspace names to edit access. E.g. -wn workspace1 -wn workspace2  [required]
-* `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be either `Edit` or `Manage`  [default: Edit]
+* `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be `View`, `Edit`, or `Manage`  [default: Edit]
 * `-op, --operation INTEGER`: Operation type.
  ROLE_OPERATION_UNSPECIFIED:0
 ROLE_OPERATION_GRANT:1
@@ -630,7 +632,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.
+* `-nq, --no_queue`: Don&#x27;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)
@@ -656,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't submit to queue: True or False.
+* `-nq, --no_queue`: Don&#x27;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)
 * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
@@ -1404,7 +1406,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: /home/runner/work/semantic-data-platform/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: /Users/christian/Projects/semantic-data-platform/bigeye-integrations/bigeye-cli]
 * `--help`: Show this message and exit.
 
 # `bigeye issues`
@@ -1536,7 +1538,7 @@ $ bigeye deltas create-delta [OPTIONS]
 * `-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]
 * `-dc, --delta_conf TEXT`: Simple Delta configuration file.  [required]
-* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
+* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn&#x27;t exist.
 * `--help`: Show this message and exit.
 
 ## `bigeye deltas run-delta`

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/CLI_DOCS.md

@@ -1,5 +1,5 @@
 # **Bigeye CLI**
-Version: 0.3.67
+Version: 0.3.69
 ## Installation
 
 **Setting up your local/build environment**  
@@ -198,7 +198,7 @@ $ bigeye configure [OPTIONS] COMMAND [ARGS]...
 
 ## `bigeye configure set`
 
-Set any specific configuration settings. 
+Set any specific configuration settings.
 
 **Usage**:
 
@@ -219,7 +219,7 @@ $ bigeye configure set [OPTIONS] [SETTING_KEY] [SETTING_VALUE]
 
 ## `bigeye configure get`
 
-Get any specific configuration settings. 
+Get any specific configuration settings.
 
 **Usage**:
 
@@ -239,7 +239,7 @@ $ bigeye configure get [OPTIONS] [SETTING_KEY]
 
 ## `bigeye configure list`
 
-List all configured workspaces. 
+List all configured workspaces.
 
 **Usage**:
 
@@ -278,7 +278,7 @@ $ bigeye workspace [OPTIONS] COMMAND [ARGS]...
 * `delete-named-schedule`: Delete a named schedule.
 * `export-named-schedule`: Export cron schedule to yaml file
 * `invite-user`: Invite a user to a workspace.
-* `edit-user`: Edit an existing user's access to groups.
+* `edit-user`: Edit an existing user's access to groups.
 * `delete-user`: Deletes a users account.
 * `upsert-workspace`: Create or update a workspace.
 * `delete-workspace`: Delete a workspace.
@@ -428,7 +428,7 @@ $ bigeye workspace invite-user [OPTIONS]
 
 ## `bigeye workspace edit-user`
 
-Edit an existing user's access to groups.
+Edit an existing user's access to groups.
 
 **Usage**:
 
@@ -543,7 +543,7 @@ $ bigeye workspace edit-group-access [OPTIONS]
 * `-name, --group-name TEXT`: Group name.  [required]
 * `-id, --group-id INTEGER`: Group ID.
 * `-wn, --workspace-name TEXT`: List of workspace names to edit access. E.g. -wn workspace1 -wn workspace2  [required]
-* `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be either `Edit` or `Manage`  [default: Edit]
+* `-access, --access-level TEXT`: The access this group should have to the workspaces provided. Must be `View`, `Edit`, or `Manage`  [default: Edit]
 * `-op, --operation INTEGER`: Operation type.
  ROLE_OPERATION_UNSPECIFIED:0
 ROLE_OPERATION_GRANT:1
@@ -610,7 +610,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.
+* `-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)
@@ -636,7 +636,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.
+* `-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)
 * `-auto_approve, --auto_approve`: Explicit plan approval is not needed prior to execution.
@@ -1384,7 +1384,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: /home/runner/work/semantic-data-platform/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: /Users/christian/Projects/semantic-data-platform/bigeye-integrations/bigeye-cli]
 * `--help`: Show this message and exit.
 
 # `bigeye issues`
@@ -1516,7 +1516,7 @@ $ bigeye deltas create-delta [OPTIONS]
 * `-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]
 * `-dc, --delta_conf TEXT`: Simple Delta configuration file.  [required]
-* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
+* `-ul, --update_lineage`: Should lineage between source and target be checked/created if doesn't exist.
 * `--help`: Show this message and exit.
 
 ## `bigeye deltas run-delta`

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/bigconfig/bigconfig_commands.py

@@ -8,6 +8,7 @@ from bigeye_cli.functions import cli_client_factory
 from bigeye_cli import global_options
 from bigeye_cli.bigconfig import bigconfig_options
 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
@@ -73,7 +74,7 @@ def plan(
         )
     if cicd:
         gh_report = GitHubReport(github_token=os.environ["GITHUB_TOKEN"])
-        gh_report.publish_bigconfig_plan(plan=report)
+        gh_report.publish_bigconfig(console_report=report, file_reports=all_reports())
 
 
 @app.command()

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/configure/configure_commands.py

@@ -61,7 +61,7 @@ def configure(
                 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)
+                    password = Prompt.ask("Enter Bigeye password for username above")
                     create_key = Confirm.ask("Would you like to create an API Key?")
                     basic_cred = BasicAPIAuth(base_url=base_url,
                                               user=username,
@@ -73,14 +73,14 @@ def configure(
                             cred=basic_cred, name=key_name, description=key_description
                         )
                     else:
-                        api_key = Prompt.ask("Enter the API Key", password=True)
+                        api_key = Prompt.ask("Enter the API Key")
 
                     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_key = Prompt.ask("Enter the API Key")
                     api_auth = APIKeyAuth(base_url=base_url, api_key=api_key)
                     required_config = get_workspace_id_for_user(cred=api_auth,
                                                                 workspace=workspace,
@@ -93,7 +93,7 @@ def configure(
             else:
                 base_url = Prompt.ask("Enter the Bigeye URL", default="https://app.bigeye.com")
                 username = Prompt.ask("Enter the username")
-                password = Prompt.ask("Enter the password", password=True)
+                password = Prompt.ask("Enter the password")
                 cred = BasicAPIAuth(base_url=base_url,
                                     user=username,
                                     password=password)

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/model/github_report.py

@@ -1,11 +1,13 @@
 import os
 from dataclasses import dataclass
+from typing import List
 
 from github import Github
 from github.Issue import Issue
 from github.PullRequest import PullRequest
 from github.Repository import Repository
 
+from bigeye_sdk.bigconfig_validation.big_config_reports import BIGCONFIG_REPORT
 from bigeye_sdk.log import get_logger
 from bigeye_sdk.generated.com.bigeye.models.generated import DeltaInfo
 from bigeye_cli.model.vendor_report import (
@@ -31,7 +33,7 @@ class GitHubReport(VendorReport):
         self.pr = self.repo.get_pull(int(os.environ["PR_NUMBER"]))
 
     def publish(
-        self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
+            self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
     ) -> int:
 
         dti = di.comparison_target_infos[0]
@@ -43,9 +45,6 @@ class GitHubReport(VendorReport):
             log.error("The process will exit as failed.")
             report = _format_report(url, source_table_name, target_table_name, dti)
             body = f"Bigeye Delta failure for PR: {self.pr.title}\n\n{report}"
-            # self.issue = self.repo.create_issue(
-            #     title=failure_title, body=report, assignee=self.pr.user, labels=["bug"]
-            # )
             self.pr.create_issue_comment(body=body)
             return 1
         elif dti.schema_match is False:
@@ -62,7 +61,7 @@ class GitHubReport(VendorReport):
             return 0
 
     def publish_group_bys(
-        self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
+            self, base_url: str, source_table_name: str, target_table_name: str, di: DeltaInfo
     ):
         dti = di.comparison_target_infos[0]
         group_bys = di.delta.comparison_table_configurations[0].group_bys
@@ -70,5 +69,18 @@ class GitHubReport(VendorReport):
         report = _format_group_report(url, source_table_name, target_table_name, dti, group_bys)
         self.pr.create_issue_comment(body=report)
 
-    def publish_bigconfig_plan(self, plan: str):
-        self.pr.create_issue_comment(body=plan)
+    def publish_bigconfig(self, console_report: str, file_reports: List[BIGCONFIG_REPORT]):
+        self.pr.create_issue_comment(body=console_report)
+        full_report = []
+        for report in file_reports:
+            cleansed_source_name = report.source_name.replace("/", "").replace(" ", "_")
+            title = f"{cleansed_source_name}"
+            source_report = (f"<details>"
+                             f"  <summary><b>Full Plan: {title}</b></summary>"
+                             f"\n\n"
+                             f"```yaml\n"
+                             f"{report}\n"
+                             f"```\n"
+                             f"</details>")
+            full_report.append(source_report)
+        self.pr.create_issue_comment(body="\n".join(full_report))

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/model/vendor_report.py

@@ -1,6 +1,7 @@
 import abc
 from typing import List
 
+from bigeye_sdk.bigconfig_validation.big_config_reports import BIGCONFIG_REPORT
 from bigeye_sdk.generated.com.bigeye.models.generated import ComparisonMetricInfo, ComparisonMetricStatus, \
     PredefinedMetricName, DeltaTargetInfo, ColumnNamePair, Delta, DeltaInfo
 
@@ -103,7 +104,7 @@ class VendorReport(abc.ABC):
         pass
 
     @abc.abstractmethod
-    def publish_bigconfig_plan(self, plan: str):
+    def publish_bigconfig(self, console_report: str, file_reports: List[BIGCONFIG_REPORT]):
         pass
 
 # This generated Markdown tables similar to the dimensional view in Bigeye.

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/bigeye_cli/workspace/workspace_commands.py

@@ -20,7 +20,7 @@ from bigeye_sdk.generated.com.bigeye.models.generated import (
     Workspace,
     Group,
     RoleOperation,
-    Group,
+    Group, BulkChangeGroupGrantsResponse,
 )
 
 log = get_logger(__file__)
@@ -486,7 +486,7 @@ def edit_group_access(
             "Edit",
             "--access-level",
             "-access",
-            help="The access this group should have to the workspaces provided. Must be either `Edit` or `Manage`",
+            help="The access this group should have to the workspaces provided. Must be `View`, `Edit`, or `Manage`",
         ),
         operation: int = typer.Option(
             RoleOperation.ROLE_OPERATION_GRANT.value,
@@ -498,9 +498,9 @@ def edit_group_access(
     """Edit the workspaces that a group can access."""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
 
-    if access_level.lower() not in ["edit", "manage"]:
+    if access_level.lower() not in ["view", "edit", "manage"]:
         raise typer.BadParameter(
-            f"Invalid access level provided. Must be either `Manage` or `Edit `"
+            f"Invalid access level provided. Must be `View`, `Edit`, or `Manage`"
         )
 
     if group_id:
@@ -530,43 +530,38 @@ def edit_group_access(
     workspaces: List[Workspace] = [
         w for w in client.get_workspaces().workspaces if w.name in workspace_names
     ]
-    workspace_ids: List[int] = [w.id for w in workspaces]
-    roles = [
-        r
-        for r in client.get_roles().roles
-        if r.workspace_id in workspace_ids and r.name.lower() == access_level.lower()
-    ]
+    role = next(r for r in client.get_roles().roles
+                if r.name.lower() == access_level.lower())
+    workspace_ids = [w.id for w in workspaces]
 
     # warn user of workspace names not found
     valid_workspace_names = [w.name.lower() for w in workspaces]
     for w in workspace_names:
-        if w not in valid_workspace_names:
+        if w.lower() not in valid_workspace_names:
             log.warning(
                 f"Workspace name `{w}` could not be found and will not be added to {group_name} access."
             )
 
-    response = client.edit_group_roles(
-        group_id=group.id,
-        role_ids=[r.id for r in roles],
+    response: BulkChangeGroupGrantsResponse = client.edit_group_roles(
+        group=group,
+        role=role,
+        workspace_ids=workspace_ids,
         operation=RoleOperation(operation),
     )
 
     # warn user that some group/role pairs may have failed to update
     for failed_update in response.failed_updates:
-        failed_role = next(filter(lambda r: r.id == failed_update.id, roles), None)
         log.warning(
-            f"Group role failed to be updated. Group = {group.name}, Role = {failed_role.name}"
+            f"Group role failed to be updated. Group = {failed_update.request.group.display_name}, "
+            f"Role = {failed_update.request.role.name}, "
+            f"Workspace = {failed_update.request.workspace.display_name}"
         )
 
     # validate all successful updates
-    for succeeded_id in response.successful_ids:
-        succeeded_role = next(filter(lambda r: r.id == succeeded_id, roles), None)
-        succeeded_workspace = next(
-            filter(lambda w: w.id == succeeded_role.workspace_id, workspaces), None
-        )
+    for successful_update in response.successful_requests:
         log.info(
-            f"Group {group.name} has been updated for the {succeeded_role.name} role "
-            f"in the {succeeded_workspace.name} workspace."
+            f"Group {successful_update.group.display_name} has been updated for the {successful_update.role.name} role "
+            f"in the {successful_update.workspace.display_name} workspace."
         )
 
 

{bigeye_cli-0.3.67 → bigeye_cli-0.3.69}/pyproject.toml

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