pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/commands/cat/list_cert_types.py

@@ -0,0 +1,194 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List certification types
+
+
+A simple display for certification types
+"""
+import argparse
+import os
+import sys
+import time
+import json
+
+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,
+    AssetCatalog,
+    ClassificationManager,
+)
+
+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"))
+
+
+disable_ssl_warnings = True
+
+
+def display_certifications(
+    search_string: 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)) and (search_string != "*"):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = ClassificationManager(
+        server, url, user_id=username, user_pwd=user_password
+    )
+    token = g_client.create_egeria_bearer_token(username, user_password)
+
+    def generate_table(search_string: str = None) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Certifications Types  @ {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("Title", max_width=15)
+        table.add_column("summary")
+        table.add_column("domainID")
+        table.add_column("Unique Name")
+        table.add_column("Scope")
+        # table.add_column("Qualified Name",max_width=15)
+        table.add_column("Description")
+        table.add_column("Details")
+        table.add_column("Related Elements")
+
+        certs = g_client.get_elements(search_string, page_size=100, time_out=time_out)
+        if type(certs) is str:
+            return table
+
+        for element in certs:
+            properties = element["properties"]
+            summary = properties.get("summary", "---")
+            domain = properties.get("domainIdentifier", "---")
+            unique_name = properties.get("qualifiedName", "---")
+            scope = properties.get("scope", "---")
+            description = properties.get("description", "---")
+            details = properties.get("details", "---")
+            title = properties.get("title", "---")
+            cert_guid = element["elementHeader"]["guid"]
+
+            related = g_client.get_related_elements(cert_guid)
+            if (len(related) > 0) and (type(related) is list):
+                rel_md = ""
+                for rel in related:
+                    rel_type = rel["relationshipHeader"]["type"]["typeName"]
+                    rel_element_props = rel["relatedElement"]["properties"]
+                    rel_el_md = f"* Rel Type: {rel_type}\n"
+                    for key in rel_element_props.keys():
+                        rel_el_md += f"* {key}: {rel_element_props[key]}\n"
+                    rel_md += f"----\n{rel_el_md}\n"
+            else:
+                rel_md = "---"
+
+            # 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")
+            #
+            # for match in nested:
+            #     match_type_name = match['type']['typeName']
+            #     matching_guid = match['guid']
+            #     match_props = match['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(
+                title, summary, domain, unique_name, scope, description, details, rel_md
+            )
+
+        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), 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="*")
+        search_string = "CertificationType"
+        display_certifications(search_string, server, url, userid, user_pass, time_out)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/list_collections.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple display for collections
+"""
+import argparse
+import os
+import time
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    EgeriaTech,
+    print_exception_response,
+)
+
+disable_ssl_warnings = True
+
+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 display_collections(
+    search_string: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    """Display either a specified glossary or all collections if the search_string is '*'.
+    Parameters
+    ----------
+    search_string : str, default is '*'
+        The string used to search for collections.
+    view_server : str
+        The view server name or address where the Egeria services are hosted.
+    view_url : str
+        The URL of the platform the view server is on.
+    user : str
+        The user ID for authentication with the Egeria server.
+    user_pass : str
+        The password for authentication with the Egeria server.
+    jupyter : bool, optional
+        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
+    width : int, optional
+        The width of the console output (default is EGERIA_WIDTH).
+    """
+    m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        table = Table(
+            title=f"Collection List @ {time.asctime()}",
+            style="bright_white on black",
+            header_style="bright_white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
+            expand=True,
+        )
+        table.add_column("Collection Name")
+        table.add_column(
+            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
+        )
+        table.add_column("Home Metadata Collection")
+        table.add_column("Description")
+        table.add_column("Collection Type")
+
+        collections = m_client.find_collections(
+            search_string.strip(), None, False, ends_with=False, ignore_case=True
+        )
+        if type(collections) is list:
+            sorted_collection_list = sorted(
+                collections, key=lambda k: k["properties"]["name"]
+            )
+            for collection in sorted_collection_list:
+                display_name = collection["properties"]["name"]
+                qualified_name = collection["properties"]["qualifiedName"]
+                home_metadata_collection = collection["elementHeader"]["origin"][
+                    "homeMetadataCollectionName"
+                ]
+                guid = collection["elementHeader"]["guid"]
+                q_name = Text(f"{qualified_name}\n&\n{guid}", justify="center")
+                description = collection["properties"]["description"]
+                collection_type = collection["properties"].get("collectionType", "---")
+                table.add_row(
+                    display_name,
+                    q_name,
+                    home_metadata_collection,
+                    description,
+                    collection_type,
+                )
+            console = Console(
+                style="bold bright_white on black",
+                width=width,
+                force_terminal=not jupyter,
+            )
+            console.print(table)
+        else:
+            print("==> No collections with that name found")
+
+    except (
+        InvalidParameterException,
+        UserNotAuthorizedException,
+        PropertyServerException,
+    ) as e:
+        print_exception_response(e)
+    finally:
+        m_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="User 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
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        search_string = Prompt.ask(
+            "Enter the collection you are searching for or '*' for all:", default="*"
+        ).strip()
+
+        display_collections(search_string, server, url, userid, user_pass)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/list_deployed_catalogs.py

@@ -0,0 +1,217 @@
+"""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_catalogs(
+    catalog_server: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    """
+    Display the list of deployed catalogs. These could be metadata catalogs or other catalogs such as database catalogs..
+
+    Parameters
+    ----------
+    catalog_server : str, optional
+        The name of the catalog server to query. Default is "*" for all catalog servers.
+    view_server : str, optional
+        The server providing the view. Default is EGERIA_VIEW_SERVER.
+    view_url : str, optional
+        The URL of the view server. Default is EGERIA_VIEW_SERVER_URL.
+    user : str, optional
+        The user ID for authentication. Default is EGERIA_USER.
+    user_pass : str, optional
+        The password for the user. Default is EGERIA_USER_PASSWORD.
+    jupyter : bool, optional
+        Enable Jupyter notebook output. Default is EGERIA_JUPYTER.
+    width : int, optional
+        The width of the console output. Default is EGERIA_WIDTH.
+    """
+    c_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
+    token = c_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Catalog List @ {time.asctime()}",
+            caption=f"Catalogs found: {view_url} - {view_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("Catalog Name/GUID", width=38, no_wrap=True)
+        table.add_column("Catalog Server")
+        table.add_column("Properties")
+        table.add_column("Catalog Schemas")
+
+        if catalog_server in [None, "*"]:
+            cats = c_client.get_elements_by_classification(
+                "Anchors", "DataAccessManager"
+            )
+        else:
+            server_guid = c_client.get_guid_for_name(catalog_server)
+            cats = c_client.get_elements_by_classification_with_property_value(
+                "Anchors", server_guid, ["anchorGUID"], "DataAccessManager"
+            )
+        if type(cats) is list:
+            for cat in cats:
+                header = cat["elementHeader"]
+
+                if check_if_template(header):
+                    continue
+                el_guid = header["guid"]
+                el_name = cat["properties"].get("name", "---")
+                el_id = f"{el_name}\n{el_guid}"
+                el_home = header["origin"]["homeMetadataCollectionName"]
+
+                el_anchors_md = ""
+                class_info = header["classifications"]
+                for class_i in class_info:
+                    class_prop = class_i.get("classificationProperties", None)
+                    if class_prop:
+                        for anchor in class_prop.keys():
+                            if anchor == "anchorGUID":
+                                server_guid = class_prop[anchor]
+                            el_anchors_md += f"* **{anchor}**: {class_prop[anchor]}\n"
+                el_anchors_out = Markdown(el_anchors_md)
+
+                el_props_md = ""
+                for prop in cat["properties"].keys():
+                    el_props_md += f"* **{prop}**: {cat['properties'][prop]}\n"
+                el_props_out = Markdown(el_props_md)
+
+                schemas = c_client.get_elements_by_classification_with_property_value(
+                    "Anchors", el_guid, ["anchorGUID"], "DeployedDatabaseSchema"
+                )
+                schemas_md = ""
+                if type(schemas) is list:
+                    cnt = 0
+                    for schema in schemas:
+                        schema_md = ""
+                        schema_props = schema["properties"]
+                        for key in schema_props.keys():
+                            schema_md += f"* **{key}**: {schema_props[key]}\n"
+
+                        spacer = "---\n" if cnt > 0 else ""
+                        cnt += 1
+                        schemas_md += f"{spacer}{schema_md}"
+                schemas_md_out = Markdown(schemas_md)
+
+                element_info = c_client.get_element_by_guid(server_guid)
+                element_info_md = ""
+                for key in element_info["properties"].keys():
+                    element_info_md += (
+                        f"* **{key}**: {element_info['properties'][key]}\n"
+                    )
+                element_info_out = Markdown(element_info_md)
+
+                table.add_row(
+                    el_id,
+                    element_info_out,
+                    el_props_out,
+                    schemas_md_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 view server to use")
+    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:
+        uc_server_name = Prompt.ask(
+            "Enter the name of a server to retrieve catalogs for", default="*"
+        )
+        list_deployed_catalogs(uc_server_name, server, url, userid, password)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()