pyegeria 0.3.3__py3-none-any.whl → 0.3.5__py3-none-any.whl

pyegeria-0.3.5.data/scripts/engine_action_status.py

@@ -0,0 +1,145 @@
+#!python
+"""
+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 status display for Engine Actions
+"""
+
+import argparse
+import json
+import time
+
+from rich import box
+from rich.live import Live
+from rich.table import Table
+from rich import console
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria import GovEng, AutomatedCuration
+
+disable_ssl_warnings = True
+
+good_platform1_url = "https://127.0.0.1:9443"
+good_platform2_url = "https://egeria.pdr-associates.com:7443"
+bad_platform1_url = "https://localhost:9443"
+
+# good_platform1_url = "https://127.0.0.1:30080"
+# good_platform2_url = "https://127.0.0.1:30081"
+# bad_platform1_url = "https://localhost:9443"
+
+good_user_1 = "garygeeke"
+good_user_2 = "erinoverview"
+bad_user_1 = "eviledna"
+bad_user_2 = ""
+
+good_server_1 = "active-metadata-store"
+good_server_2 = "simple-metadata-store"
+good_server_3 = "view-server"
+good_server_4 = "engine-host"
+bad_server_1 = "coco"
+bad_server_2 = ""
+
+
+def display_status_engine_actions(server: str = good_server_3, url: str = good_platform1_url, user: str = good_user_1):
+    g_client = AutomatedCuration(server, url, user, user_pwd="secret")
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Engine Action Status for Platform {good_platform1_url} @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Engine Status for Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Requested Time")
+        table.add_column("Start Time")
+
+        table.add_column("Engine Name")
+        table.add_column("Request Type")
+        table.add_column("Action Status")
+        table.add_column("Target Element")
+        table.add_column("Completion Time")
+        table.add_column("Process Name")
+        table.add_column("Completion Message")
+
+        token = g_client.create_egeria_bearer_token()
+        action_status = g_client.get_engine_actions()
+        if action_status is None:
+            requested_time = " "
+            start_time = " "
+            completion_time = " "
+            engine_name = " "
+            request_type = " "
+            action_status = " "
+            target_element = " "
+            process_name = " "
+            completion_message = " "
+        else:
+            for action in action_status:
+                requested_time = action["requestedTime"]
+                start_time = action.get("startTime", " ")
+                completion_time = action.get("completionTime", " ")
+
+                engine_name = action["governanceEngineName"]
+                request_type = action["requestType"]
+
+                if action["actionStatus"] in ("REQUESTED", "APPROVED", "WAITING", "ACTIVATING"):
+                    action_status = f"[yellow]{action['actionStatus']}"
+                elif action["actionStatus"] in ("IN_PROGRESS", "ACTIONED"):
+                    action_status = f"[green]{action['actionStatus']}"
+                else:
+                    action_status = f"[red]{action['actionStatus']}"
+
+                target= action.get("actionTargetElements","Empty")
+                if type(target) is list:
+                    target_element = json.dumps(target[0]["targetElement"]["elementProperties"]["propertiesAsStrings"])
+                else:
+                    target_element = " "
+
+                process_name = action.get("processName", " ")
+                completion_message = action.get("completionMessage", " ")
+
+                table.add_row(
+                    requested_time, start_time, engine_name, request_type,
+                    action_status, target_element, completion_time, process_name, completion_message
+                )
+
+        # 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())
+                live.console.pager()
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+
+
+if __name__ == "__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")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "view-server"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    print(f"Starting display_status_engine_actions with {server}, {url}, {userid}")
+    display_status_engine_actions(server=server, url=url, user=userid)

pyegeria-0.3.5.data/scripts/find_todos.py

@@ -0,0 +1,152 @@
+#!python
+"""
+SPDX-Lic
+ense-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 time
+import json
+import argparse
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from rich.table import Table
+from rich.live import Live
+from rich import box
+from rich.prompt import Prompt
+from rich.tree import Tree
+from rich import print
+from rich.console import Console
+from pyegeria.my_profile_omvs import MyProfile
+
+from pyegeria.server_operations import ServerOps
+from pyegeria.gov_engine import GovEng
+from pyegeria.glossary_omvs import GlossaryBrowser
+disable_ssl_warnings = True
+
+good_platform1_url = "https://127.0.0.1:9443"
+good_platform2_url = "https://egeria.pdr-associates.com:7443"
+bad_platform1_url = "https://localhost:9443"
+
+# good_platform1_url = "https://127.0.0.1:30080"
+# good_platform2_url = "https://127.0.0.1:30081"
+# bad_platform1_url = "https://localhost:9443"
+
+good_user_1 = "garygeeke"
+good_user_2 = "erinoverview"
+bad_user_1 = "eviledna"
+bad_user_2 = ""
+
+good_server_1 = "active-metadata-store"
+good_server_2 = "simple-metadata-store"
+good_server_3 = "view-server"
+good_server_4 = "engine-host"
+bad_server_1 = "coco"
+bad_server_2 = ""
+
+
+def display_to_dos(search_string: str, guid: str=None, server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_2):
+
+    m_client = MyProfile(server, url, user_id=username)
+    token = m_client.create_egeria_bearer_token(username, "secret")
+
+    def generate_table(search_string:str = '*') -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Open ToDos for Platform {good_platform1_url} @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"ToDos for Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+
+        table.add_column("Name")
+        table.add_column("Type Name")
+
+        table.add_column("Created")
+        table.add_column("Priority")
+        table.add_column("Due")
+        table.add_column("Completion")
+        table.add_column("Status")
+        table.add_column("Sponsor")
+
+        todo_items = m_client.find_to_do("*", starts_with=True)
+
+        if todo_items is None:
+            name = " "
+            type_name = " "
+            created = " "
+            priority = " "
+            due = " "
+            completed = " "
+            status = " "
+            sponsor = " "
+        else:
+            for item in todo_items:
+                props = item["properties"]
+                name = props["name"]
+                type_name = props.get("toDoType", " ")
+                created = props.get("creationTime", " ")
+                priority = str(props.get("priority", " "))
+                due = props.get("dueTime", " ")
+                completed = props.get("completionTime", " ")
+                status = props.get("status")
+                # assigned_actors = item["assignedActors"]
+                # sponsor = assigned_actors[0].get("uniqueName", " ")
+                sponsor = "erinoverview"
+                if status in ("WAITING", "OPEN"):
+                    status = f"[yellow]{status}"
+                elif status in ("INPROGRESS", "COMPLETE"):
+                    status = f"[green]{status}"
+                else:
+                    status = f"[red]{status}"
+
+                table.add_row(
+                    name, type_name, created, priority, due, completed, status, sponsor
+                )
+
+        m_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())
+        console = Console()
+        with console.pager():
+            console.print(generate_table(search_string))
+
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+
+if __name__ == "__main__":
+    sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
+    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("--sponsor", help="Name of sponsor to search")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "view-server"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'erinoverview'
+    # guid = args.guid if args.guid is not None else None
+    guid = None
+
+    search_string = Prompt.ask("Enter the ToDo you are searching for:", default="*")
+    display_to_dos(search_string, guid,server, url, userid)

pyegeria-0.3.5.data/scripts/glossary_view.py

@@ -0,0 +1,135 @@
+#!python
+"""
+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 time
+import json
+import argparse
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from rich.table import Table
+from rich.live import Live
+from rich import box
+from rich.prompt import Prompt
+from rich.tree import Tree
+from rich import print
+from rich.console import Console
+
+
+from pyegeria.server_operations import ServerOps
+from pyegeria.gov_engine import GovEng
+from pyegeria.glossary_omvs import GlossaryBrowser
+disable_ssl_warnings = True
+
+good_platform1_url = "https://127.0.0.1:9443"
+good_platform2_url = "https://egeria.pdr-associates.com:7443"
+bad_platform1_url = "https://localhost:9443"
+
+# good_platform1_url = "https://127.0.0.1:30080"
+# good_platform2_url = "https://127.0.0.1:30081"
+# bad_platform1_url = "https://localhost:9443"
+
+good_user_1 = "garygeeke"
+good_user_2 = "erinoverview"
+bad_user_1 = "eviledna"
+bad_user_2 = ""
+
+good_server_1 = "active-metadata-store"
+good_server_2 = "simple-metadata-store"
+good_server_3 = "view-server"
+good_server_4 = "engine-host"
+bad_server_1 = "coco"
+bad_server_2 = ""
+
+
+def display_glossary_terms(search_string: str, guid: str=None, server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_2):
+
+    g_client = GlossaryBrowser(server, url)
+    token = g_client.create_egeria_bearer_token(username, "secret")
+
+
+    def generate_table(search_string:str = '*') -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Glossary Definitions for Terms like  {search_string} @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Glossary View Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Display Name")
+        table.add_column("Qualified Name")
+
+        table.add_column("Abbreviation")
+        table.add_column("Summary")
+        table.add_column("Description")
+
+        terms = g_client.find_glossary_terms(search_string, guid, starts_with=True,
+                                             ends_with=False, status_filter=[], page_size=500)
+        if type(terms) is str:
+            return table
+
+        for term in terms:
+            props = term.get("glossaryTermProperties","None")
+            if props == "None":
+                return table
+
+            display_name = props["displayName"]
+            qualified_name = props["qualifiedName"]
+            abbrev = props.get("abbreviation"," ")
+            summary = props.get("summary", " ")
+            description = props.get("description", " ")
+
+
+            table.add_row(
+                display_name,qualified_name, abbrev, summary, description
+            )
+
+        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())
+        console = Console()
+        with console.pager():
+            console.print(generate_table(search_string))
+
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+
+if __name__ == "__main__":
+    sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
+    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("--guid", help="GUID of glossary to search")
+    parser.add_argument("--sustainability", help="Set True for Sustainability Glossary")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "view-server"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    guid = args.guid if args.guid is not None else None
+    guid = sus_guid  if args.sustainability else None
+
+    search_string = Prompt.ask("Enter the term you are searching for:", default="*")
+    display_glossary_terms(search_string, guid,server, url, userid)

pyegeria-0.3.5.data/scripts/gov_engine_status.py

@@ -0,0 +1,120 @@
+#!python
+"""
+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 status display for Governance Actions
+"""
+
+import time
+import json
+import argparse
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from rich.table import Table
+from rich.live import Live
+from rich import box
+from rich import console
+
+from pyegeria.server_operations import ServerOps
+from pyegeria.gov_engine import GovEng
+
+disable_ssl_warnings = True
+
+good_platform1_url = "https://127.0.0.1:9443"
+good_platform2_url = "https://egeria.pdr-associates.com:7443"
+bad_platform1_url = "https://localhost:9443"
+
+# good_platform1_url = "https://127.0.0.1:30080"
+# good_platform2_url = "https://127.0.0.1:30081"
+# bad_platform1_url = "https://localhost:9443"
+
+good_user_1 = "garygeeke"
+good_user_2 = "erinoverview"
+bad_user_1 = "eviledna"
+bad_user_2 = ""
+
+good_server_1 = "active-metadata-store"
+good_server_2 = "simple-metadata-store"
+good_server_3 = "engine-host"
+good_server_4 = "engine-host"
+bad_server_1 = "coco"
+bad_server_2 = ""
+
+
+def display_gov_actions_status(server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_1):
+    server_name = server
+    s_client = ServerOps(server_name, url, username)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Governance Engine Status @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Server: '{server_name}' running on {url}",
+            expand=True
+        )
+        # table.footer: f"Server {server_name} on Platform {good_platform1_url}"
+        table.add_column("Gov Engine")
+        table.add_column("Gov Engine Type")
+        table.add_column("Gov Engine Desc")
+        table.add_column("Engine Status")
+        table.add_column("Request Types")
+
+        gov_eng_status = s_client.get_governance_engine_summaries()
+        for engine in gov_eng_status:
+            gov_eng = engine["governanceEngineName"]
+            eng_type = engine["governanceEngineTypeName"]
+
+            eng_desc = engine["governanceEngineDescription"]
+            eng_req_type = json.dumps(engine["governanceRequestTypes"], indent = 2)
+            status = engine["governanceEngineStatus"]
+            if status in ("RUNNING"):
+                eng_status = f"[green]{status}"
+            elif status in ("FAILED"):
+                eng_status = f"[red]{status}"
+            else: eng_status = f"[yellow]{status}"
+
+            table.add_row(
+                gov_eng, eng_type, eng_desc, eng_status,eng_req_type
+            )
+
+        table.caption = f"Server {server_name} running on {url}"
+        return table
+
+    try:
+        with Live(generate_table(), refresh_per_second=1, screen=True, vertical_overflow="visible") as live:
+            while True:
+                time.sleep(2)
+                live.update(generate_table())
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+
+    finally:
+        s_client.close_session()
+
+
+if __name__ == "__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")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "engine-host"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    display_gov_actions_status(server=server, url=url, username=userid)

pyegeria-0.3.5.data/scripts/integration_daemon_status.py

@@ -0,0 +1,130 @@
+#!python
+"""
+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 status display for Engine Actions
+"""
+
+import argparse
+import json
+import time
+
+from rich import box
+from rich.live import Live
+from rich.table import Table
+from rich import console
+
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria.server_operations import ServerOps
+
+disable_ssl_warnings = True
+
+good_platform1_url = "https://127.0.0.1:9443"
+good_platform2_url = "https://egeria.pdr-associates.com:7443"
+bad_platform1_url = "https://localhost:9443"
+
+good_user_1 = "garygeeke"
+good_user_2 = "erinoverview"
+bad_user_1 = "eviledna"
+bad_user_2 = ""
+
+good_server_1 = "active-metadata-store"
+good_server_2 = "simple-metadata-store"
+good_server_3 = "view-server"
+good_server_4 = "engine-host"
+bad_server_1 = "coco"
+bad_server_2 = ""
+
+
+def display_integration_daemon_status(server: str = good_server_4, url: str = good_platform1_url,
+                                      user: str = good_user_1):
+    s_client = ServerOps(server, url, user)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Integration Daemon Status @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Integration Daemon Status for Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Connector Name")
+        table.add_column("Connector Status")
+
+        table.add_column("Last Refresh Time")
+        table.add_column("Minimum Refresh Interval (min)")
+        table.add_column("Target Element")
+        table.add_column("Exception Message")
+
+        daemon_status = s_client.get_integration_daemon_status()
+        connector_reports = daemon_status["integrationConnectorReports"]
+        for connector in connector_reports:
+            connector_name = connector["connectorName"]
+            connector_status = connector["connectorStatus"]
+            last_refresh_time = connector.get("lastRefreshTime","---")
+            refresh_interval = str(connector.get("minMinutesBetweenRefresh","---"))
+            target_element = " "
+            exception_msg = " "
+
+            if connector_name is None:
+                connector_name = "connector name"
+            if connector_status is None:
+                connector_status = "connector status"
+
+            if connector_status in ("RUNNING", "REFRESHING", "WAITING"):
+                connector_status = f"[green]{connector_status}"
+            elif connector_status in ("INITIALIZE FAILED","CONFIG_FAILED","FAILED"):
+                connector_status = f"[red]{connector_status}"
+            else:
+                connector_status = f"[yellow]{connector_status}"
+
+            # target= action.get("actionTargetElements","Empty")
+            # if type(target) is list:
+            #     target_element = json.dumps(target[0]["targetElement"]["elementProperties"]["propertiesAsStrings"])
+            # else:
+            #     target_element = " "
+
+            table.add_row(
+                connector_name,connector_status,last_refresh_time,refresh_interval,
+                target_element, exception_msg
+            )
+        return table
+
+    try:
+        with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+            while True:
+                time.sleep(2)
+                live.update(generate_table())
+                live.console.pager()
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+
+    finally:
+        s_client.close_session()
+
+
+if __name__ == "__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")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "integration-daemon"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    display_integration_daemon_status(server=server, url=url, user=userid)