pyegeria 1.5.1__tar.gz → 1.5.1.0.2__tar.gz

{pyegeria-1.5.1 → pyegeria-1.5.1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 1.5.1
+Version: 1.5.1.0.2
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

pyegeria-1.5.1.0.2/commands/cat/list_deployed_database_schemas.py

@@ -0,0 +1,197 @@
+"""This creates a templates guid file from the core metadata archive"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+
+console = Console()
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def check_if_template(header: dict) -> bool:
+    """Check if the the template classification is set"""
+    classifications = header.get("classifications", None)
+    if classifications is None:
+        return False
+    for c in classifications:
+        if c["type"]["typeName"] == "Template":
+            return True
+    return False
+
+
+def list_deployed_database_schemas(
+    db_name: str,
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Databases found: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            # title=f"Elements for Open Metadata Type: '{om_type}' ",
+            expand=True,
+            # width=500
+        )
+
+        table.add_column("Name")
+        table.add_column("Type")
+        table.add_column("Created", width=23)
+        table.add_column("Home Store")
+        table.add_column("GUID", width=38, no_wrap=True)
+        table.add_column("Properties")
+        table.add_column("Tables")
+
+        om_type = "DeployedDatabaseSchema"
+        if db_name in (None, "*"):
+            dbs = c_client.get_elements(om_type)
+        else:
+            dbs = c_client.get_elements_by_property_value(db_name, "name", om_type)
+
+        if type(dbs) is list:
+            for element in dbs:
+                header = element["elementHeader"]
+
+                if check_if_template(header):
+                    continue
+
+                el_name = element["properties"].get("name", "---")
+                el_type = header["type"]["typeName"]
+                el_home = header["origin"]["homeMetadataCollectionName"]
+                el_create_time = header["versions"]["createTime"][:-10]
+                el_created_by = header["versions"]["createdBy"]
+                el_created_md = (
+                    f"* **Created By**: {el_created_by}\n"
+                    f"* **Created Time**: {el_create_time}"
+                )
+                el_created_out = Markdown(el_created_md)
+
+                el_guid = header["guid"]
+
+                el_props_md = ""
+                for prop in element["properties"].keys():
+                    el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
+                el_props_out = Markdown(el_props_md)
+
+                rel_elements = c_client.get_related_elements(
+                    el_guid, "RelationalDBSchemaType"
+                )
+                schema_md = ""
+                count = 0
+                rel_el_out = ""
+                if type(rel_elements) is list:
+                    print(len(rel_elements))
+                    for rel_element in rel_elements:
+                        count += 1
+                        rel_type = rel_element["relatedElement"]["elementHeader"][
+                            "type"
+                        ]["typeName"]
+                        rel_guid = rel_element["relatedElement"]["elementHeader"][
+                            "guid"
+                        ]
+                        rel_props = rel_element["relatedElement"]["properties"]
+                        props_md = ""
+                        for key in rel_props.keys():
+                            props_md += f"* **{key}**: {rel_props[key]}\n"
+                        rel_el_md = f"* **{rel_type}**: {rel_guid}\n{props_md}"
+                        if count > 1:
+                            rel_el_md += "---\n"
+                    rel_el_out = Markdown(rel_el_md)
+
+                table.add_row(
+                    el_name,
+                    el_type,
+                    el_created_out,
+                    el_home,
+                    el_guid,
+                    el_props_out,
+                    rel_el_out,
+                )
+
+            return table
+        else:
+            print("No instances found")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        print("\n\nPerhaps the type name isn't known")
+    finally:
+        c_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        db_name = Prompt.ask(
+            "Enter the name of a database to retrieve schemas for", default="*"
+        )
+        list_deployed_database_schemas(db_name, server, url, userid, password)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria-1.5.1.0.2/commands/cat/list_deployed_databases.py

@@ -0,0 +1,185 @@
+"""This creates a templates guid file from the core metadata archive"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+
+console = Console()
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def check_if_template(header: dict) -> bool:
+    """Check if the the template classification is set"""
+    classifications = header.get("classifications", None)
+    if classifications is None:
+        return False
+    for c in classifications:
+        if c["type"]["typeName"] == "Template":
+            return True
+    return False
+
+
+def list_deployed_databases(
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Databases found: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            # title=f"Elements for Open Metadata Type: '{om_type}' ",
+            expand=True,
+            # width=500
+        )
+
+        table.add_column("Qualified Name")
+        table.add_column("Type")
+        table.add_column("Created", width=23)
+        table.add_column("Home Store")
+        table.add_column("GUID", width=38, no_wrap=True)
+        table.add_column("Properties")
+        table.add_column("Schemas")
+
+        om_type = "Database"
+        dbs = c_client.get_elements(om_type)
+        if type(dbs) is list:
+            for element in dbs:
+                header = element["elementHeader"]
+
+                if check_if_template(header):
+                    continue
+
+                el_q_name = element["properties"].get("qualifiedName", "---")
+                el_type = header["type"]["typeName"]
+                el_home = header["origin"]["homeMetadataCollectionName"]
+                el_create_time = header["versions"]["createTime"][:-10]
+                el_created_by = header["versions"]["createdBy"]
+                el_created_md = (
+                    f"* **Created By**: {el_created_by}\n"
+                    f"* **Created Time**: {el_create_time}"
+                )
+                el_created_out = Markdown(el_created_md)
+
+                el_guid = header["guid"]
+
+                el_props_md = ""
+                for prop in element["properties"].keys():
+                    el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
+                el_props_out = Markdown(el_props_md)
+
+                rel_elements = c_client.get_related_elements(el_guid)
+                schema_md = ""
+                count = 0
+                if type(rel_elements) is list:
+                    for rel_element in rel_elements:
+                        count += 1
+                        rel_type = rel_element["relatedElement"]["elementHeader"][
+                            "type"
+                        ]["typeName"]
+                        rel_guid = rel_element["relatedElement"]["elementHeader"][
+                            "guid"
+                        ]
+                        rel_props = rel_element["relatedElement"]["properties"]
+                        props_md = ""
+                        for key in rel_props.keys():
+                            props_md += f"* **{key}**: {rel_props[key]}\n"
+                        rel_el_md = f"* **{rel_type}**: {rel_guid}\n{props_md}"
+                        if count > 1:
+                            rel_el_md += "---\n"
+                    rel_el_out = Markdown(rel_el_md)
+
+                table.add_row(
+                    el_q_name,
+                    el_type,
+                    el_created_out,
+                    el_home,
+                    el_guid,
+                    el_props_out,
+                    rel_el_out,
+                )
+
+            return table
+        else:
+            print("No instances found")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        print("\n\nPerhaps the type name isn't known")
+    finally:
+        c_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        list_deployed_databases(server, url, userid, password)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria-1.5.1.0.2/commands/tech/get_element_graph.py

@@ -0,0 +1,202 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.markdown import Markdown
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "260"))
+
+
+disable_ssl_warnings = True
+
+
+def display_elements(
+    search_string: str,
+    prop_list: [str],
+    server: str,
+    url: str,
+    username: str,
+    user_password: str,
+    time_out: int = 60,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
+    if (search_string is None) or (len(search_string) < 3):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = EgeriaTech(server, url, username, user_password)
+    token = g_client.create_egeria_bearer_token()
+
+    def generate_table(search_string: str, prop_list: [str]) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Assets containing the string  {search_string} @ {time.asctime()}",
+            header_style="white on dark_blue",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+        # table.add_column("Qualified Name")
+        table.add_column("GUID", no_wrap=True)
+        table.add_column("Properties")
+
+        table.add_column("Classification Props", width=30)
+        table.add_column("Matching Elements")
+
+        classification = "Anchors"
+        open_type_name = None
+        property_value = search_string
+        property_names = prop_list
+
+        elements = g_client.find_elements_by_classification_with_property_value(
+            classification, property_value, property_names, open_type_name
+        )
+        if type(elements) is str:
+            return table
+
+        for element in elements:
+            template = False
+            guid = element["elementHeader"].get("guid", "---")
+            classifications = element["elementHeader"]["classifications"]
+
+            class_prop_md = ""
+            for classific in classifications:
+                class_prop = classific.get("classificationProperties", "---")
+                if type(class_prop) is dict:
+                    for key in class_prop.keys():
+                        class_prop_md += f"* {key}: {class_prop[key]}\n"
+
+            class_prop_out = Markdown(class_prop_md)
+
+            properties = element["properties"]
+            props_md = ""
+            if type(properties) is dict:
+                for key in properties.keys():
+                    props_md += f"* {key}: {properties[key]}\n"
+                    if key == "category" and properties[key] == "placeholderProperty":
+                        template = True
+            props_out = Markdown(props_md)
+
+            if template:  # Not interested in template elements in this method
+                continue
+
+            relationship = g_client.get_related_elements(guid, None, None)
+
+            if type(relationship) is list:
+                rel_md = ""
+                for rel in relationship:
+                    match_tab = Table(expand=True)
+                    match_tab.add_column("Type Name")
+                    match_tab.add_column("GUID", no_wrap=True, width=36)
+                    match_tab.add_column("Properties")
+                    match = rel["relationshipHeader"]
+                    match_type_name = match["type"]["typeName"]
+                    matching_guid = match["guid"]
+                    match_props = rel["relatedElement"]["properties"]
+                    match_details_md = ""
+                    for key in match_props.keys():
+                        match_details_md += f"* {key}: {match_props[key]}\n"
+                    match_details_out = Markdown(match_details_md)
+                    match_tab.add_row(match_type_name, matching_guid, match_details_out)
+
+            table.add_row(guid, props_out, class_prop_out, match_tab)
+
+        g_client.close_session()
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+
+        with console.pager(styles=True):
+            console.print(generate_table(search_string, prop_list), soft_wrap=True)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        console.print_exception()
+        sys.exit(1)
+
+    except ValueError as e:
+        console.print(
+            f"\n\n====> Invalid Search String - must be greater than four characters long"
+        )
+        sys.exit(1)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+    parser.add_argument("--time_out", help="Time Out")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    time_out = args.time_out if args.time_out is not None else 60
+    try:
+        search_string = Prompt.ask("Enter an asset search string:", default="")
+        prop_list = Prompt.ask(
+            "Enter the list of properties to search", default="anchorTypeName"
+        )
+        display_elements(
+            search_string, [prop_list], server, url, userid, user_pass, time_out
+        )
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-1.5.1 → pyegeria-1.5.1.0.2}/pyegeria/classification_manager_omvs.py

@@ -1,7 +1,7 @@
 """PDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-This module contains an initial version of the feedback_manager_omvs
+This module contains an initial version of the classification_manager_omvs
 module.
 
 """

{pyegeria-1.5.1 → pyegeria-1.5.1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "1.5.1"
+version = "1.5.1.0.2"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -116,7 +116,8 @@ pytest = "^8.2.2"
     get_element_info = "commands.tech.get_element_info:main"
     list_elements = "commands.tech.list_elements:main"
     list_related_specification = "commands.tech.list_related_specification:main"
-    list_elements_by_classification = "commands.tech.list_elements_by_classification:main"
+    list_elements_by_classification = "commands.tech.list_elements_for_classification:main"
     list_related_elements = "commands.tech.list_related_elements:main"
 
     list_valid_metadata_values = "commands.tech.list_valid_metadata_values:main"
+    list_element_graph = "commands.tech.get_element_graph:main"