bigeye-cli 0.3.53__tar.gz → 0.3.54__tar.gz

bigeye_cli-0.3.54/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.1
+Name: bigeye-cli
+Version: 0.3.54
+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
+Requires-Python: >=3.9.0,<4.0.0
+Classifier: License :: Other/Proprietary License
+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.74,<0.5.0)
+Requires-Dist: click (>=8.0.4,<9.0.0)
+Requires-Dist: rich (>=12.4.4,<13.0.0)
+Description-Content-Type: text/markdown
+
+# **Bigeye CLI**
+Version: 0.3.54
+## Installation
+
+**Setting up your local/build environment**  
+Mac with Pyenv
+
+1. Install [brew](https://brew.sh/)
+2. Install [pyenv](https://formulae.brew.sh/formula/pyenv)
+3. Install python and define a default global:
+
+```text
+pyenv install 3.9.13
+pyenv global 3.9.13
+```
+
+Conda  
+Install [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)  
+Create environment with python3.9 or greater
+
+```text
+conda create -n bigeye_env python=3.9
+conda activate bigeye_env
+```
+
+Linux  
+Most linux distributes include a default python distribution and we recommend using that default.
+
+**Installing Bigeye-CLI**
+
+You can install the Bigeye-CLI from your command line with the following command:
+
+```text
+pip3 install bigeye-cli
+```
+
+## Configuration
+
+Before using the Bigeye CLI, you will need to configure your Bigeye credentials and workspaces. You can do this in the following ways:
+
+- Configuration Command
+- Environment Variables
+- Credentials and Configuration Files
+
+### Configuration Command
+The quickest way to get started using the Bigeye CLI is to run the `bigeye configure` command. This command will walk you through the options to establish default credentials and configurations for the Bigeye CLI.
+
+
+```console
+$ bigeye configure
+```
+
+Using the bigeye configure command, there are two ways to authenticate: basic authentication and browser authentication.
+
+#### Basic Authentication
+
+If you select basic authentication, the CLI will prompt you to enter your Bigeye username and password. This will create a default credential file at ~/.bigeye/credentials. This credential will be used for all CLI commands  
+unless an environment variable is explicitly provided.
+
+#### Browser Authentication
+
+Alternatively, you can use browser authentication (Linux/Mac OS only). Login to your bigeye workspace on a Chrome, Chromium or  
+Firefox browser. Run **bigeye configure** and select browser_auth when prompted in the CLI and follow the  
+instructions. If you use Chrome profiles, make sure to specify the profile email address you are logged into.
+
+Note: Your authentication will only be valid so long as your browser session is active. Not supported with SSO enabled.
+
+### Environment Variables
+
+You can create an environment variable for your workspace credential and configuration files, this is helpful if you would like to store your credential and configuration files some place other than their default locations (~/.bigeye). You can do this by adding the following to your ~/.bashrc or ~/.zshrc file. Please review the format of these files in the below sections.
+
+```shell
+export BIGEYE_API_CRED_FILE=/some/path/to/credentials.ini
+export BIGEYE_API_CONFIG_FILE=/some/path/to/config.ini
+```
+
+### Credentials and Configuration Files
+
+Lastly, if you want to specify the credential per command, you can always pass a -b parameter with the file path for the desired credential. You can pass a -c parameter with the file path for the desired configuration.
+
+_Sample credentials file:_
+
+```ini Text
+[DEFAULT]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+password = fakepassword1234
+```
+
+_Sample configuration file:_
+
+```ini
+[DEFAULT]
+workspace_id = 123
+```
+
+#### Configuration Options
+
+The configuration files can help to simplify other CLI commands by defining common options in one file. See  
+the table below for the complete list of configuration options.
+
+| **Key**                | **Description**                                                                                     | **Type**      | **Example**                            |
+| ---------------------- | --------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- |
+| workspace_id           | The id for the workspace [Required]                                                                 | Int           | 123                                    |
+| use_default_credential | Whether or not a unique credential is required for this workspace. Default: True                    | Bool          | True                                   |
+| bigconfig_input_path   | The path(s) to bigconfig files that are used for the given workspace.                               | List[strings] | path/bigconfig.yml,path2/bigconfig.yml |
+| bigconfig_output_path  | The path used to output bigconfig PLAN reports and FIXME files.                                     | String        | output/bigconfig_reports/              |
+| bigconfig_strict_mode  | API errors cause an exception if True. (Validation errors still cause an exception). Default: False | Bool          | False                                  |
+| bigconfig_auto_approve | Bigconfig applies should be allowed to run without excplit plan approvals. Default: False           | Bool          | False                                  |
+
+
+The configuration options above can be manually set directly in your config.ini files or you can utilize the below command to set the config values.
+
+```console
+$ bigeye configure set <setting_key> <value> [OPTIONAL WORKSPACE]
+$ bigeye configure set bigconfig_input_path path/bigconfig.yml,path2/bigconfig -w data-science
+```
+
+To view the current value of any specific configuration you can either open the config.ini file or utilize the below command.
+
+```console
+$ bigeye configure get <setting_key> [OPTIONAL WORKSPACE]
+$ bigeye configure get bigconfig_input_path -w data-science
+```
+
+### Multi-Workspace Support
+
+The credential and configuration files are designed to allow Bigeye CLI users to easily switch between their Bigeye workspaces. Each file enforces the idea of a `DEFAULT` section. All subsequent CLI commands will inherit the properties defined in the `DEFAULT`section unless they are directed otherwise. Every command in the Bigeye CLI has the ability to provide a `--workspace` (`-w`) option to override the use of the default workspace.
+
+To setup a non-default workspace, run the following command:
+
+```console
+$ bigeye configure -w data-science
+```
+
+Or, open up the files and manually edit them based on your setup. Here are some samples. 
+
+_Sample configuration file with multiple workspaces:_
+
+```ini
+[DEFAULT]
+workspace_id = 123
+bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
+bigconfig_output_path = absolute_path/output/
+
+[workspace data-science]
+workspace_id = 234
+use_default_credential = True
+bigconfig_input_path = absolute_path/ds/bigconfig.yml,absolute_path2/ds/bigconfig.yml
+
+[workspace dev]
+workspace_id = 100
+use_default_credential = False
+bigconfig_auto_approve = True
+bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
+```
+
+_Sample credentials file with multiple workspaces:_
+
+```ini
+[DEFAULT]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+password = fakepassword1234
+
+[dev]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+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_cli-0.3.54/bigeye_cli/CLI_DOCS.md

@@ -0,0 +1,174 @@
+# **Bigeye CLI**
+Version: 0.3.54
+## Installation
+
+**Setting up your local/build environment**  
+Mac with Pyenv
+
+1. Install [brew](https://brew.sh/)
+2. Install [pyenv](https://formulae.brew.sh/formula/pyenv)
+3. Install python and define a default global:
+
+```text
+pyenv install 3.9.13
+pyenv global 3.9.13
+```
+
+Conda  
+Install [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)  
+Create environment with python3.9 or greater
+
+```text
+conda create -n bigeye_env python=3.9
+conda activate bigeye_env
+```
+
+Linux  
+Most linux distributes include a default python distribution and we recommend using that default.
+
+**Installing Bigeye-CLI**
+
+You can install the Bigeye-CLI from your command line with the following command:
+
+```text
+pip3 install bigeye-cli
+```
+
+## Configuration
+
+Before using the Bigeye CLI, you will need to configure your Bigeye credentials and workspaces. You can do this in the following ways:
+
+- Configuration Command
+- Environment Variables
+- Credentials and Configuration Files
+
+### Configuration Command
+The quickest way to get started using the Bigeye CLI is to run the `bigeye configure` command. This command will walk you through the options to establish default credentials and configurations for the Bigeye CLI.
+
+
+```console
+$ bigeye configure
+```
+
+Using the bigeye configure command, there are two ways to authenticate: basic authentication and browser authentication.
+
+#### Basic Authentication
+
+If you select basic authentication, the CLI will prompt you to enter your Bigeye username and password. This will create a default credential file at ~/.bigeye/credentials. This credential will be used for all CLI commands  
+unless an environment variable is explicitly provided.
+
+#### Browser Authentication
+
+Alternatively, you can use browser authentication (Linux/Mac OS only). Login to your bigeye workspace on a Chrome, Chromium or  
+Firefox browser. Run **bigeye configure** and select browser_auth when prompted in the CLI and follow the  
+instructions. If you use Chrome profiles, make sure to specify the profile email address you are logged into.
+
+Note: Your authentication will only be valid so long as your browser session is active. Not supported with SSO enabled.
+
+### Environment Variables
+
+You can create an environment variable for your workspace credential and configuration files, this is helpful if you would like to store your credential and configuration files some place other than their default locations (~/.bigeye). You can do this by adding the following to your ~/.bashrc or ~/.zshrc file. Please review the format of these files in the below sections.
+
+```shell
+export BIGEYE_API_CRED_FILE=/some/path/to/credentials.ini
+export BIGEYE_API_CONFIG_FILE=/some/path/to/config.ini
+```
+
+### Credentials and Configuration Files
+
+Lastly, if you want to specify the credential per command, you can always pass a -b parameter with the file path for the desired credential. You can pass a -c parameter with the file path for the desired configuration.
+
+_Sample credentials file:_
+
+```ini Text
+[DEFAULT]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+password = fakepassword1234
+```
+
+_Sample configuration file:_
+
+```ini
+[DEFAULT]
+workspace_id = 123
+```
+
+#### Configuration Options
+
+The configuration files can help to simplify other CLI commands by defining common options in one file. See  
+the table below for the complete list of configuration options.
+
+| **Key**                | **Description**                                                                                     | **Type**      | **Example**                            |
+| ---------------------- | --------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- |
+| workspace_id           | The id for the workspace [Required]                                                                 | Int           | 123                                    |
+| use_default_credential | Whether or not a unique credential is required for this workspace. Default: True                    | Bool          | True                                   |
+| bigconfig_input_path   | The path(s) to bigconfig files that are used for the given workspace.                               | List[strings] | path/bigconfig.yml,path2/bigconfig.yml |
+| bigconfig_output_path  | The path used to output bigconfig PLAN reports and FIXME files.                                     | String        | output/bigconfig_reports/              |
+| bigconfig_strict_mode  | API errors cause an exception if True. (Validation errors still cause an exception). Default: False | Bool          | False                                  |
+| bigconfig_auto_approve | Bigconfig applies should be allowed to run without excplit plan approvals. Default: False           | Bool          | False                                  |
+
+
+The configuration options above can be manually set directly in your config.ini files or you can utilize the below command to set the config values.
+
+```console
+$ bigeye configure set <setting_key> <value> [OPTIONAL WORKSPACE]
+$ bigeye configure set bigconfig_input_path path/bigconfig.yml,path2/bigconfig -w data-science
+```
+
+To view the current value of any specific configuration you can either open the config.ini file or utilize the below command.
+
+```console
+$ bigeye configure get <setting_key> [OPTIONAL WORKSPACE]
+$ bigeye configure get bigconfig_input_path -w data-science
+```
+
+### Multi-Workspace Support
+
+The credential and configuration files are designed to allow Bigeye CLI users to easily switch between their Bigeye workspaces. Each file enforces the idea of a `DEFAULT` section. All subsequent CLI commands will inherit the properties defined in the `DEFAULT`section unless they are directed otherwise. Every command in the Bigeye CLI has the ability to provide a `--workspace` (`-w`) option to override the use of the default workspace.
+
+To setup a non-default workspace, run the following command:
+
+```console
+$ bigeye configure -w data-science
+```
+
+Or, open up the files and manually edit them based on your setup. Here are some samples. 
+
+_Sample configuration file with multiple workspaces:_
+
+```ini
+[DEFAULT]
+workspace_id = 123
+bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
+bigconfig_output_path = absolute_path/output/
+
+[workspace data-science]
+workspace_id = 234
+use_default_credential = True
+bigconfig_input_path = absolute_path/ds/bigconfig.yml,absolute_path2/ds/bigconfig.yml
+
+[workspace dev]
+workspace_id = 100
+use_default_credential = False
+bigconfig_auto_approve = True
+bigconfig_input_path = absolute_path/bigconfig.yml,absolute_path2/bigconfig.yml
+```
+
+_Sample credentials file with multiple workspaces:_
+
+```ini
+[DEFAULT]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+password = fakepassword1234
+
+[dev]
+base_url = https://app.bigeye.com
+user = some_user@bigeye.com
+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_cli-0.3.53 → bigeye_cli-0.3.54}/bigeye_cli/deltas/deltas_commands.py

@@ -96,7 +96,7 @@ def suggest_deltas(
             target_selector[1]
         )
         matching_target_tables = (
-            lineage_controller.infer_relationships_from_lists_of_tables(
+            lineage_controller.infer_relationships_from_lists(
                 target_1_tables, target_2_tables
             )
         )
@@ -104,7 +104,7 @@ def suggest_deltas(
             mtt[0].name: mtt[1] for mtt in matching_target_tables
         }
 
-    matching_tables = lineage_controller.infer_relationships_from_lists_of_tables(
+    matching_tables = lineage_controller.infer_relationships_from_lists(
         upstream=upstream_tables, downstream=target_1_tables, match_type=match_type
     )
 

{bigeye_cli-0.3.53 → bigeye_cli-0.3.54}/bigeye_cli/lineage/lineage_commands.py

@@ -1,7 +1,6 @@
 from typing import Optional
 
 import typer
-from rich.progress import track
 
 
 from bigeye_cli.exceptions.exceptions import InvalidEntityException
@@ -160,35 +159,15 @@ def infer_relations(
             , case_sensitive=False
         )
 ):
-    """Given an upstream and downstream path, infers lineage based on table names and creates the relationships."""
+    """Given an upstream and downstream path, infers lineage based on table/column names and creates the edges."""
     client = cli_client_factory(bigeye_conf, config_file, workspace)
     lineage_controller = LineageController(client)
 
-    upstream_tables = lineage_controller.get_tables_from_selector(
-        selector=upstream_selector
-    )
-    downstream_tables = lineage_controller.get_tables_from_selector(
-        selector=downstream_selector
-    )
-
-    matching_tables = lineage_controller.infer_relationships_from_lists_of_tables(upstream=upstream_tables,
-                                                                                  downstream=downstream_tables,
-                                                                                  match_type=match_type)
+    # Get matching tables
+    matching_tables = lineage_controller.get_matching_tables_from_selectors(upstream_selector=upstream_selector,
+                                                                            downstream_selector=downstream_selector,
+                                                                            match_type=match_type)
 
     log.info(f'Identified {len(matching_tables)} table relationships between upstream and downstream sources.')
 
-    count_successful_relations = 0
-    for match in track(matching_tables, description="Creating relationships..."):
-        upstream = match[0]
-        downstream = match[1]
-        try:
-            lineage_controller.create_relation_from_tables(upstream=upstream, downstream=downstream)
-            count_successful_relations += 1
-        except Exception as e:
-            log.warning(f'Failed to create relationship between upstream table: {upstream.name} and downstream table: '
-                        f'{downstream.name}. Exception: {e}')
-
-    log.info(
-        f"Successfully created {count_successful_relations} of {len(matching_tables)}"
-        f" table relationships."
-    )
+    lineage_controller.infer_column_level_lineage_from_tables(matching_tables)

{bigeye_cli-0.3.53 → bigeye_cli-0.3.54}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "bigeye-cli"
-version = "0.3.53"
+version = "0.3.54"
 description = "Bigeye CLI offers developer tools for maintaining your developer workspace."
 license = "Proprietary"
 authors = ["Bigeye <support@bigeye.com>"]
@@ -19,7 +19,7 @@ bigeye = "bigeye_cli.__main__:app"
 [tool.poetry.dependencies]
 python = "^3.9.0"
 click = "^8.0.4"
-bigeye-sdk = "^0.4.73"
+bigeye-sdk = "^0.4.74"
 rich = "^12.4.4"
 PyGithub = '^1.57'
 
@@ -31,7 +31,7 @@ mypy = "^1.1.1"
 
 [tool.poe.tasks]
     pre_build = []
-    pre_publish = ["clean", "docgen"]
+    pre_publish = ["clean"]
     post_publish = ["clean"]
 
     [tool.poe.poetry_hooks]