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

pyegeria/automated_curation_omvs.py

@@ -19,16 +19,21 @@ from ._validators import validate_name, validate_guid, validate_search_string
 
 class AutomatedCuration(Client):
     """ Set up and maintain automation services in Egeria.
-    class AutomatedCuration(Platform):
-
-        def __init__(
-                self,
-                server_name: str,
-                platform_url: str,
-                user_id: str,
-                user_pwd: str = None,
-                verify_flag: bool = False,
-        ):
+
+    Attributes:
+        server_name : str
+            The name of the View Server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
+
     """
 
     def __init__(

pyegeria/core_omag_server_config.py

@@ -24,31 +24,24 @@ from pyegeria._validators import (
 class CoreServerConfig(Client):
     """
     CoreServerConfig is a class that extends the Client class. It provides methods to configure and interact with access
-     services in the OMAG server.
+    services in the OMAG server.
 
-    Methods:
+    Attributes:
 
-        - get_stored_configuration(server_name: str = None) -> dict:
-            Retrieves all the configuration documents for a server.
+        server_name: str
+            The name of the OMAG server to configure.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
 
-        - get_configured_access_services(server_name: str = None) -> dict:
-            Returns the list of access services that are configured for this server.
 
-        - configure_all_access_services(server_name: str = None) -> None:
-            Enables all access services that are registered with this server platform.
-
-        - configure_all_access_services_no_topics(server_name: str = None) -> None:
-            Configures all access services for the specified server with no cohort/Event Bus.
-
-        - clear_all_access_services(server_name: str = None) -> None:
-            Disables the access services. This removes all configuration for the access services and disables the
-            enterprise repository services.
-
-        - get_access_service_config(access_service_name: str, server_name: str = None) -> dict:
-            Retrieves the config for an access service.
-
-        - configure_access_service(access_service_name: str, server_name: str = None) -> None:
-            Enables a single access service.
      """
 
     def __init__(

pyegeria/full_omag_server_config.py

@@ -601,7 +601,6 @@ class FullServerConfig(CoreServerConfig):
 
         self.make_request("POST", url, target_url_root)
 
-
     def get_event_bus(self, server_name: str = None) -> dict:
         """ Returns the event bus configuration for the specified server
 

pyegeria/glossary_omvs.py

@@ -26,8 +26,20 @@ class GlossaryBrowser(Client):
     GlossaryBrowser is a class that extends the Client class. It provides methods to search and retrieve glossaries,
     terms and categories.
 
-    Methods:
-
+    Attributes:
+
+        server_name: str
+            The name of the View Server to connect to.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
 
      """
 

pyegeria/gov_engine.py

@@ -33,7 +33,7 @@ class GovEng(Client):
 
        Attributes:
            server_name: str
-                Name of the server to configure.
+                Name of the server to use.
            platform_url : str
                URL of the server platform to connect to
            user_id : str
@@ -45,13 +45,6 @@ class GovEng(Client):
                 Set true for SSL verification to be enabled, false for disabled. Default behaviour set by the
                 enable_ssl_check attribute from _globals.py
 
-       Methods:
-           __init__(self,
-                    platform_url: str,
-                    end_user_id: str,
-                    )
-            Initializes the connection - throwing an exception if there is a problem
-
        """
 
     def __init__(

pyegeria/governance_author.py

@@ -22,6 +22,8 @@ class GovernanceAuthor(AutomatedCuration):
 
     Attributes:
 
+        server_name: str
+                Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str

pyegeria/my_profile_omvs.py

@@ -20,7 +20,7 @@ class MyProfile(Client):
     Parameters
     ----------
     server_name : str
-        The name of the server to configure.
+        The name of the view server to configure.
     platform_url : str
         The URL of the platform.
     token : str, optional

pyegeria/platform_services.py

@@ -30,7 +30,8 @@ class Platform(Client):
     Client to operate Egeria Platforms - inherits from Server Ops
 
     Attributes:
-
+        server_name: str
+                Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str
@@ -42,44 +43,6 @@ class Platform(Client):
             Flag to indicate if SSL Certificates should be verified in the HTTP requests.
             Defaults to False.
 
-    Methods:
-        __init__(self, platform_url: str, end_user_id: str)
-         Initializes the connection - throwing an exception if there is a problem
-
-
-
-        get_platform_origin() -> str
-
-        activate_server_stored_config(server: str = None, timeout: int = 30) -> None
-
-        activate_server_supplied_config(config_body: str, server: str = None, timeout: int = 30) -> None
-
-        get_active_server_instance_status(server: str = None)-> dict | str
-
-        get_known_servers() -> list[str] | str
-
-        is_server_known(server: str = None) -> bool
-
-        is_server_configured(server: str = None) -> bool
-
-        check_server_active(server: str = None)
-
-        get_active_server_list() -> dict | str
-
-        shutdown_platform() -> None:
-
-        shutdown_server(server: str = None) -> None:
-
-        shutdown_unregister_servers() -> None
-
-        shutdown_all_servers() -> None
-
-        activate_server_if_down(server: str) -> bool
-
-        activate_servers_on_platform(server_list: str) -> bool
-
-       activate_platform(self, platform_name: str, hosted_server_names: [str], timeout:int = 60) -> None
-
     """
 
     admin_command_root: str

pyegeria/registered_info.py

@@ -27,6 +27,8 @@ class RegisteredInfo(Client):
 
     Attributes:
     ----------
+        server_name: str
+                Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str
@@ -55,11 +57,11 @@ class RegisteredInfo(Client):
 
     def __init__(
             self,
+            server_name: str,
             platform_url: str,
             user_id: str,
             user_pwd: str = None,
             verify_flag: bool = False,
-            server_name: str = None
     ):
         if server_name is None:
             server_name = "NA"

pyegeria/server_operations.py

@@ -19,7 +19,8 @@ class ServerOps(Platform):
     Client to issue operations on a running OMAG server.
 
     Attributes:
-
+        server_name: str
+            Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str
@@ -31,7 +32,6 @@ class ServerOps(Platform):
             Flag to indicate if SSL Certificates should be verified in the HTTP requests.
             Defaults to False.
 
-    Methods:
 
     """
     def __init__(

pyegeria-0.3.4.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.4.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.4.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)