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

pyegeria/commands/tech/list_relationship_types.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+Get valid relationship types.
+"""
+import argparse
+import os
+import time
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria import ValidMetadataManager
+
+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_relationship_types(
+    type_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool = False,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    p_client = ValidMetadataManager(server, url, user_id=username)
+    token = p_client.create_egeria_bearer_token(username, user_pass)
+
+    def generate_table(type_name: str) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Relationship types for: {type_name}  @ {time.asctime()}",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            header_style="white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"list for Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+
+        table.add_column("Name")
+        table.add_column("Status")
+        table.add_column("Description")
+        table.add_column("Description Wiki", no_wrap=True)
+        table.add_column("Attributes", min_width=50)
+
+        types_list = p_client.get_valid_relationship_types(type_name)
+
+        print(type(types_list))
+        if types_list is None:
+            name = " "
+            guid = " "
+            status = " "
+
+        elif type(types_list) == str:
+            print(types_list)
+            raise ValueError("-->This is not a known Type")
+        else:
+            for types in types_list:
+                name = types["name"]
+                # guid = types['guid']
+                status = types["initialStatus"]
+                description = types["description"]
+                description_wiki = types.get("descriptionWiki", " ")
+                attribute_defs = types.get("attributeDefinitions")
+
+                att_table = Table(show_lines=True)
+                att_table.add_column("Name")
+                att_table.add_column("Description")
+                att_table.add_column("Status")
+                att_table.add_column("Type")
+
+                if attribute_defs:
+                    att_md = True
+                    for attr in attribute_defs:
+                        attr_name = attr["attributeName"]
+                        attr_desc = attr["attributeDescription"]
+                        attr_status = attr["attributeStatus"]
+                        attr_type = attr["attributeType"]["name"]
+                        att_table.add_row(attr_name, attr_desc, attr_status, attr_type)
+
+                else:
+                    att_md = False
+            att_out = att_table if att_md else " "
+
+            table.add_row(name, status, description, description_wiki, att_out)
+        p_client.close_session()
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter, record=True)
+        with console.pager(styles=True):
+            console.print(generate_table(type_name))
+        if save_output:
+            console.save_html("projects.html")
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
+        if type(e) is str:
+            print(e)
+        else:
+            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")
+    parser.add_argument("--save-output", help="Save output to file?")
+
+    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
+    save_output = args.save_output if args.save_output is not None else False
+    type_name = Prompt.ask(
+        "Enter the OM Type Name to retrieve relationships for:", default="AssetOwner"
+    )
+
+    display_relationship_types(type_name, server, url, userid, user_pass, save_output)
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/tech/list_relationships.py

@@ -0,0 +1,179 @@
+#!/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
+
+from rich import box
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    ClassificationManager,
+    max_paging_size,
+)
+
+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 list_relationships(
+    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"Relationship List for {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("End 1 Name")
+        table.add_column("End 1 GUID", no_wrap=True)
+        table.add_column("End 1 Type")
+        table.add_column("End 2 Name")
+        table.add_column("End 2 GUID", no_wrap=True)
+        table.add_column("End 2 Type")
+        table.add_column("Properties", min_width=40)
+
+        rel_list = g_client.get_relationships(
+            search_string, page_size=max_paging_size, time_out=time_out
+        )
+        if type(rel_list) is str:
+            return table
+
+        for rel in rel_list:
+            end1_name = rel["end1"].get("uniqueName", "---")
+            end1_guid = rel["end1"]["guid"]
+            end1_type = rel["end1"]["type"]["typeName"]
+            end2_name = rel["end2"].get("uniqueName", "---")
+            end2_guid = rel["end2"]["guid"]
+            end2_type = rel["end2"]["type"]["typeName"]
+
+            rel_md = ""
+            p_test = rel.get("properties", "---")
+            if type(p_test) is str:
+                rel_md = "---"
+            else:
+                for key in rel["properties"].keys():
+                    rel_md += f"* {key}: {rel['properties'][key]}\n"
+
+            rel_out = Markdown(rel_md)
+
+            table.add_row(
+                end1_name,
+                end1_guid,
+                end1_type,
+                end2_name,
+                end2_guid,
+                end2_type,
+                rel_out,
+            )
+
+        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="Certification"
+        )
+
+        list_relationships(search_string, server, url, userid, user_pass, time_out)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()