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

pyegeria/commands/cat/get_collection.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for collections - provide the root and we display the hierarchy
+
+"""
+
+import argparse
+import os
+from rich import print
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.text import Text
+from rich.tree import Tree
+
+from pyegeria import (
+    CollectionManager,
+    UserNotAuthorizedException,
+    PropertyServerException,
+    InvalidParameterException,
+)
+from pyegeria._exceptions import (
+    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 collection_viewer(
+    root: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    """A simple collection viewer"""
+
+    def walk_collection_hierarchy(
+        tree: Tree,
+        collection_client: CollectionManager,
+        root_collection_guid: str = None,
+        root_collection_name: str = None,
+        root_collection_qname: str = None,
+    ) -> None:
+        """Recursively build a Tree with collection contents."""
+        members = collection_client.get_member_list(
+            root_collection_guid, root_collection_name, root_collection_qname
+        )
+        if type(members) is list:
+            for member in members:
+                style = "bold white on black"
+                text_collection_name = Text(
+                    f"[bold white on black]Name: {member['name']}", style=style
+                )
+                text_qualified_name = Text(
+                    f"* QualifiedName: {member['qualifiedName']}"
+                )
+                text_guid = Text(f"* GUID: {member['guid']}", "green")
+                text_collection_type = Text(
+                    f"* Collection Type: {member['collectionType']}"
+                )
+                text_description = Text(f"* Description: {member['description']}")
+                p = Panel.fit(
+                    f"{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
+                    f"{text_collection_type}\n{text_description}"
+                )
+                tt = tree.add(p, style=style)
+
+                children = collection_client.get_collection_members(
+                    collection_guid=member["guid"]
+                )
+                if type(children) is list:
+                    branch = tt.add(
+                        f"[bold magenta on black]Members",
+                        style=style,
+                        guide_style=style,
+                    )
+                    walk_collection_hierarchy(branch, collection_client, member["guid"])
+        else:
+            tt = tree.add(
+                f"[bold magenta on black]No collections found in {root_collection_name}"
+            )
+
+    try:
+        tree = Tree(f"[bold bright green]{root}", guide_style="bold bright_blue")
+        c_client = CollectionManager(server_name, platform_url, user_id=user)
+
+        token = c_client.create_egeria_bearer_token(user, user_password)
+        walk_collection_hierarchy(tree, c_client, None, root)
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        if e.exception_error_message_parameters[1] == "No elements found":
+            print("The collection was not found.")
+        else:
+            print_exception_response(e)
+    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="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:
+        root_collection = Prompt.ask(
+            "Enter the Root Collection to start from:",
+            default="Digital Products Root",
+        )
+        collection_viewer(root_collection, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/get_project_dependencies.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for project dependencies - provide the root and we display the dependency tree
+
+"""
+
+import argparse
+import os
+
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.tree import Tree
+
+from pyegeria import (
+    ProjectManager,
+    UserNotAuthorizedException,
+    PropertyServerException,
+    InvalidParameterException,
+)
+from pyegeria._exceptions import (
+    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 project_dependency_viewer(
+    root: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    timeout: int = 30,
+):
+    """A simple collection viewer"""
+
+    def walk_project_hierarchy(
+        project_client: ProjectManager,
+        project_name: str,
+        tree: Tree,
+        root: bool = False,
+    ) -> None:
+        """Recursively build a Tree with collection contents."""
+        t = None
+        style = "bright_white on black"
+
+        project = project_client.get_projects_by_name(project_name)
+        if type(project) is list:
+            proj_guid = project[0]["elementHeader"]["guid"]
+            proj_props = project[0]["properties"]
+
+            proj_type = proj_props.get("typeName", "---")
+            proj_unique = proj_props.get("qualifiedName", "---")
+            proj_identifier = proj_props.get("identifier", "---")
+            proj_name = proj_props.get("name", "---")
+            proj_desc = proj_props.get("description", "---")
+            proj_status = proj_props.get("projectStatus", "---")
+            proj_priority = proj_props.get("priority", "---")
+            proj_start = proj_props.get("startDate", "---")[:-10]
+            proj_props_md = (
+                f"* Name: {proj_name}\n"
+                f"* Identifier: {proj_identifier}\n"
+                f"* Type: {proj_type}\n"
+                f"* Status: {proj_status}\n"
+                f"* priority: {proj_priority}\n"
+                f"* Start:    {proj_start}\n"
+                f"* Description: {proj_desc}\n"
+                f"* GUID: {proj_guid}"
+            )
+        else:
+            return
+
+        team = project_client.get_project_team(proj_guid)
+        member_md = ""
+        if type(team) is list:
+            for member in team:
+                member_guid = member["member"]["guid"]
+                member_unique = member["member"]["uniqueName"]
+                member_md += f"* Member Unique Name: {member_unique}\n* Member GUID: {member_guid}"
+            proj_props_md += f"\n### Team Members\n {member_md}"
+
+        proj_props_out = Markdown(proj_props_md)
+        p = Panel.fit(proj_props_out, style=style, title=project_name)
+        t = tree.add(p)
+
+        linked_projects = project_client.get_linked_projects(proj_guid)
+        if type(linked_projects) is list:
+            for proj in linked_projects:
+                child_md = ""
+                child_guid = proj["elementHeader"]["guid"]
+                child_name = proj["properties"]["name"]
+                relationship = proj["relatedElement"]["relationshipHeader"]["type"][
+                    "typeName"
+                ]
+                if relationship != "ProjectDependency":
+                    continue
+                walk_project_hierarchy(project_client, child_name, t)
+
+        else:
+            return t
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+        tree = Tree(
+            f"[bold bright green on black]{root}", guide_style="bold bright_blue"
+        )
+        p_client = ProjectManager(server_name, platform_url, user_id=user)
+
+        token1 = p_client.create_egeria_bearer_token(user, user_password)
+
+        walk_project_hierarchy(p_client, root, tree, root=True)
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+
+
+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:
+        root_project = Prompt.ask(
+            "Enter the Root Project to start from:", default="Sustainability Campaign"
+        )
+        project_dependency_viewer(root_project, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/get_project_structure.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for project structure - provide the root and we display the hierarchy
+
+"""
+
+import argparse
+import os
+
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.tree import Tree
+
+from pyegeria import (
+    ProjectManager,
+    UserNotAuthorizedException,
+    PropertyServerException,
+    InvalidParameterException,
+)
+from pyegeria._exceptions import (
+    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 project_structure_viewer(
+    root: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    timeout: int = 30,
+):
+    """A simple collection viewer"""
+
+    def walk_project_hierarchy(
+        project_client: ProjectManager,
+        project_name: str,
+        tree: Tree,
+        root: bool = False,
+    ) -> None:
+        """Recursively build a Tree with collection contents."""
+        t = None
+        style = "bright_white on black"
+
+        project = project_client.get_projects_by_name(project_name)
+        if type(project) is list:
+            proj_guid = project[0]["elementHeader"]["guid"]
+            proj_props = project[0]["properties"]
+
+            proj_type = proj_props.get("typeName", "---")
+            proj_unique = proj_props.get("qualifiedName", "---")
+            proj_identifier = proj_props.get("identifier", "---")
+            proj_name = proj_props.get("name", "---")
+            proj_desc = proj_props.get("description", "---")
+            proj_status = proj_props.get("projectStatus", "---")
+            proj_priority = proj_props.get("priority", "---")
+            proj_start = proj_props.get("startDate", "---")[:-10]
+            proj_props_md = (
+                f"* Name: {proj_name}\n"
+                f"* Identifier: {proj_identifier}\n"
+                f"* Type: {proj_type}\n"
+                f"* Status: {proj_status}\n"
+                f"* priority: {proj_priority}\n"
+                f"* Start:    {proj_start}\n"
+                f"* Description: {proj_desc}\n"
+                f"* GUID: {proj_guid}"
+            )
+        else:
+            return
+
+        team = project_client.get_project_team(proj_guid)
+        member_md = ""
+        if type(team) is list:
+            for member in team:
+                member_guid = member["member"]["guid"]
+                member_unique = member["member"]["uniqueName"]
+                member_md += f"* Member Unique Name: {member_unique}\n* Member GUID: {member_guid}"
+            proj_props_md += f"\n### Team Members\n {member_md}"
+
+        proj_props_out = Markdown(proj_props_md)
+        p = Panel.fit(proj_props_out, style=style, title=project_name)
+        t = tree.add(p)
+
+        linked_projects = project_client.get_linked_projects(proj_guid)
+        if type(linked_projects) is list:
+            for proj in linked_projects:
+                child_md = ""
+                child_guid = proj["elementHeader"]["guid"]
+                child_name = proj["properties"]["name"]
+                relationship = proj["relatedElement"]["relationshipHeader"]["type"][
+                    "typeName"
+                ]
+                if relationship != "ProjectHierarchy":
+                    continue
+                walk_project_hierarchy(project_client, child_name, t)
+
+        else:
+            return t
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+        tree = Tree(
+            f"[bold bright green on black]{root}", guide_style="bold bright_blue"
+        )
+        p_client = ProjectManager(server_name, platform_url, user_id=user)
+
+        token1 = p_client.create_egeria_bearer_token(user, user_password)
+
+        walk_project_hierarchy(p_client, root, tree, root=True)
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+
+
+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:
+        root_project = Prompt.ask(
+            "Enter the Root Project to start from:", default="Sustainability Campaign"
+        )
+        project_structure_viewer(root_project, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/get_tech_type_elements.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Display the status of cataloged platforms and servers.
+"""
+import sys
+import time
+import argparse
+import os
+
+from rich import json
+from rich.panel import Panel
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AutomatedCuration,
+)
+from rich.table import Table
+from rich.live import Live
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.tree import Tree
+from rich.prompt import Prompt
+from rich.panel import Panel
+from rich.text import Text
+from rich import print
+
+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
+console = Console(width=200)
+
+guid_list = []
+
+
+def tech_viewer(
+    tech_name: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_pass: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    def build_classifications(classification: dict) -> Markdown:
+        class_md = "\n"
+        for c in classification:
+            c_type = c["classificationName"]
+            if c_type == "Anchors":
+                continue
+            class_md += f"* Classification: {c_type}\n"
+            class_props = c.get("classificationProperties", None)
+            if class_props is None:
+                continue
+            for prop in class_props.keys():
+                class_md += f"\t* {prop}: {class_props[prop]}\n"
+        if class_md == "-":
+            output = None
+        else:
+            output = class_md
+        return output
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        a_client = AutomatedCuration(server_name, platform_url, user_id=user)
+
+        token = a_client.create_egeria_bearer_token(user, user_pass)
+        tech_elements = a_client.get_technology_type_elements(
+            tech_name, get_templates=False
+        )
+        if type(tech_elements) is str:
+            console.print(f"No elements found for {tech_name}")
+            sys.exit(1)
+
+        tree = Tree(
+            f"Deployed Technology Type: {tech_name}",
+            style="bold bright_white on black",
+            guide_style="bold bright_blue",
+        )
+        note: str = " "
+        for element in tech_elements:
+            header = element["elementHeader"]
+            tech_type = header["type"]["typeName"]
+            tech_collection = header["origin"]["homeMetadataCollectionName"]
+            tech_created_by = header["versions"]["createdBy"]
+            tech_created_at = header["versions"]["createTime"]
+            tech_guid = header["guid"]
+            tech_classifications = header["classifications"]
+            class_md = build_classifications(tech_classifications)
+
+            referenceables = element["referenceableProperties"]
+            tech_qualified_name = referenceables["qualifiedName"]
+            extended = referenceables["extendedProperties"]
+            ex_md: str = ""
+            for key, value in extended.items():
+                ex_md += f"* {key}: {value}\n"
+
+            note = (
+                f"* Qualified Name: {tech_qualified_name}\n"
+                f"* GUID: {tech_guid}\n"
+                f"* Created by: {tech_created_by}\n"
+                f"* Created at: {tech_created_at}\n"
+                f"* Home Collection: {tech_collection}\n"
+                f"{class_md}\n"
+                f"{ex_md}\n"
+            )
+
+            interfaces = extended.get("connectorInterfaces", None)
+            if interfaces is not None:
+                interface_type_name = interfaces["typeName"]
+                interface_array_cnt = interfaces["arrayCount"]
+                note += f"* Interface Type: {interface_type_name}\n"
+                for i in range(0, int(interface_array_cnt)):
+                    note += (
+                        f"\t* Type: {interfaces['arrayValues']['propertyValueMap'][str(i)]['typeName']}"
+                        f"\tName: {interfaces['arrayValues']['propertiesAsStrings'][str(i)]}\n"
+                    )
+            note_md = Panel.fit(Markdown(note), style="bold bright_white")
+            t = tree.add(note_md)
+
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+
+
+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:
+        tech_name = Prompt.ask(
+            "Enter the Asset Name to view:", default="PostgreSQL Server"
+        )
+        tech_viewer(tech_name, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()