pyegeria 0.8.4.9__py3-none-any.whl → 0.8.4.10__py3-none-any.whl

examples/widgets/ops/monitor_server_list.py

@@ -0,0 +1,140 @@
+#!/usr/bin/env python3
+"""
+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 server status display
+"""
+import argparse
+import os
+import time
+
+from rich.live import Live
+from rich.table import Table
+
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria.core_omag_server_config import CoreServerConfig
+from pyegeria.server_operations import ServerOps
+
+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_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+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_status(
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    p_client = ServerOps(server, url, username)
+    c_client = CoreServerConfig(server, url, username, user_pass)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Server Status for Platform - {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",
+            caption=f"Server Status for Platform - '{url}'",
+            show_lines=True,
+            # expand=True
+        )
+
+        table.add_column("Known Server")
+        table.add_column("Status")
+        table.add_column("Server Type")
+        table.add_column("Server Description")
+        known_server_list = p_client.get_known_servers()
+        active_server_list = p_client.get_active_server_list()
+        if len(known_server_list) == 0:
+            return table
+
+        for server in known_server_list:
+            if server in active_server_list:
+                status = "Active"
+            else:
+                status = "Inactive"
+            server_type = c_client.get_server_type_classification(server)[
+                "serverTypeName"
+            ]
+            description = c_client.get_basic_server_properties(server).get(
+                "localServerDescription", " "
+            )
+
+            table.add_row(
+                server,
+                "[red]Inactive" if status == "Inactive" else "[green]Active",
+                server_type,
+                description,
+            )
+
+        return table
+
+    try:
+        with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+            while True:
+                time.sleep(2)
+                live.update(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+
+    finally:
+        p_client.close_session()
+        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_METADATA_STORE
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    display_status(server, url, userid, user_pass)
+
+
+if __name__ == "__main__":
+    main()

examples/widgets/ops/monitor_server_status.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python3
+"""
+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 server status display
+"""
+import argparse
+import os
+import time
+
+from rich.live import Live
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    ServerOps
+)
+
+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_INTEGRATION_DAEMON_URL = os.environ.get('EGERIA_INTEGRATION_DAEMON_URL', 'https://localhost:9443')
+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_status(server: str, url: str, username: str, user_pass: str, jupyter: bool = EGERIA_JUPYTER,
+                   width: int = EGERIA_WIDTH):
+    p_client = ServerOps(server, url, username, user_pass)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Server Status for Platform - {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",
+            caption=f"Server Status for Platform - '{url}'",
+            # show_lines=True,
+        )
+
+        table.add_column("Known Server")
+        table.add_column("Status")
+
+        known_server_list = p_client.get_known_servers()
+        active_server_list = p_client.get_active_server_list()
+        if len(known_server_list) == 0:
+            return table
+
+        for server in known_server_list:
+            if server in active_server_list:
+                status = "Active"
+            else:
+                status = "Inactive"
+
+            table.add_row(server,
+                          "[red]Inactive" if status == "Inactive" else "[green]Active",
+                          )
+        # p_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())
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        p_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_METADATA_STORE
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    display_status(server, url, userid, user_pass)
+
+
+if __name__ == "__main__":
+    main()

examples/widgets/ops/refresh_integration_daemon.py

@@ -0,0 +1,73 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This script refreshed an integration daemon.
+
+"""
+
+import os
+import argparse
+import time
+
+from pyegeria import ServerOps, AutomatedCuration
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+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_INTEGRATION_DAEMON_URL = os.environ.get('EGERIA_INTEGRATION_DAEMON_URL', 'https://localhost:9443')
+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')
+
+
+
+def refresh_connector(connector: str, server:str, url:str, userid:str, password:str):
+    try:
+
+        s_client = ServerOps(server, url, userid)
+        if connector == 'all':
+            connector = None
+            statement = "ALL connectors"
+        else:
+            statement = f"the {connector} "
+
+        s_client.refresh_integration_connectors(connector, server, time_out = 60)
+
+        print(f"\n===> Integration Daemon \'{server}\' refreshed {statement}.")
+
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+
+
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the integration daemon to refresh")
+    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("--connector", default='all', help="Name of the connector to refresh")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_INTEGRATION_DAEMON
+    url = args.url if args.url is not None else EGERIA_INTEGRATION_DAEMON_URL
+    userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    refresh_connector(args.connector, server, url, userid, user_pass)
+
+if __name__ == "__main__":
+    main()

examples/widgets/ops/restart_integration_daemon.py

@@ -0,0 +1,73 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This script restarts an integration daemon.
+
+"""
+
+import os
+import argparse
+import time
+
+from pyegeria import ServerOps, AutomatedCuration
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+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_INTEGRATION_DAEMON_URL = os.environ.get('EGERIA_INTEGRATION_DAEMON_URL', 'https://localhost:9443')
+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')
+
+
+
+def restart_connector(connector: str, server:str, url:str, userid:str, password:str):
+    try:
+
+        s_client = ServerOps(server, url, userid)
+        if connector == 'all':
+            connector = None
+            statement = "ALL connectors"
+        else:
+            statement = f"the {connector} "
+
+        s_client.restart_integration_connector(connector, server, time_out = 60)
+
+        print(f"\n===> Integration Daemon \'{server}\' restarted {statement}.")
+
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+
+
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the integration daemon to refresh")
+    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("--connector", default='all', help="Name of the connector to refresh")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_INTEGRATION_DAEMON
+    url = args.url if args.url is not None else EGERIA_INTEGRATION_DAEMON_URL
+    userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    restart_connector(args.connector, server, url, userid, user_pass)
+
+if __name__ == "__main__":
+    main()

pyegeria/classification_manager_omvs.py

@@ -431,17 +431,159 @@ class ClassificationManager(Client):
         )
         return response
 
+    async def _async_get_element_by_guid(
+        self,
+        element_guid: str,
+        effective_time: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
+    ) -> dict | str:
+        """
+        Retrieve element by its unique identifier.  Async version.
+
+        https://egeria-project.org/types/
+
+        Parameters
+        ----------
+        element_guid: str
+            - unique identifier for the element
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        for_lineage: bool, default is set by server
+           - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+           - Normally false. Set true when the caller is part of a deduplication function
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        dict | str
+            Returns a string if no elements found; otherwise a dict of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "EffectiveTimeQueryRequestBody",
+            "effectiveTime": effective_time,
+        }
+
+        url = f"{base_path(self, server_name)}/elements/{element_guid}{possible_query_params}"
+
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body), time_out=time_out
+        )
+
+        elements = response.json().get("elements", "No elements found")
+        if type(elements) is list:
+            if len(elements) == 0:
+                return "No elements found"
+        return elements
+
+    def get_element_by_guid(
+        self,
+        element_guid: str,
+        effective_time: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
+    ) -> dict | str:
+        """
+        Retrieve element by its unique identifier.
+
+        https://egeria-project.org/types/
+
+        Parameters
+        ----------
+        element_guid: str
+            - unique identifier for the element
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        for_lineage: bool, default is set by server
+           - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+           - Normally false. Set true when the caller is part of a deduplication function
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        dict | str
+            Returns a string if no elements found; otherwise a dict of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_element_by_guid(
+                element_guid,
+                effective_time,
+                for_lineage,
+                for_duplicate_processing,
+                server_name,
+                time_out,
+            )
+        )
+        return response
+
     async def _async_get_guid_for_name(
-        self, name: str, server_name: str = None, time_out: int = default_time_out
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve the guid associated with the supplied element name.
+        Retrieve the guid associated with the supplied unique element name.
         If more than one element returned, an exception is thrown. Async version.
 
         Parameters
         ----------
         name: str
             - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
         server_name: str, default = None
             - name of the server instances for this request.
         time_out: int, default = default_time_out
@@ -463,11 +605,32 @@ class ClassificationManager(Client):
         """
         if server_name is None:
             server_name = self.server_name
-        property_name = ["name", "qualifiedName", "title"]
-        elements = await self._async_get_elements_by_property_value(
-            name, property_name, None
+        property_name = "qualifiedName" if property_name is None else property_name
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "NameRequestBody",
+            "name": name,
+            "forLineage": for_lineage,
+            "forDuplicateProcessing": for_duplicate_processing,
+            "namePropertyName": property_name,
+            "effectiveTime": effective_time,
+        }
+
+        url = f"{base_path(self, server_name)}/elements/guid-by-unique-name{possible_query_params}"
+
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body), time_out=time_out
         )
 
+        elements = response.json().get("elements", "No elements found")
+
         if type(elements) is list:
             if len(elements) == 0:
                 return "No elements found"
@@ -478,16 +641,31 @@ class ClassificationManager(Client):
         return elements
 
     def get_guid_for_name(
-        self, name: str, server_name: str = None, time_out: int = default_time_out
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve the guid associated with the supplied element name.
+        Retrieve the guid associated with the supplied unique element name.
         If more than one element returned, an exception is thrown.
 
         Parameters
         ----------
         name: str
             - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
         server_name: str, default = None
             - name of the server instances for this request.
         time_out: int, default = default_time_out
@@ -510,7 +688,15 @@ class ClassificationManager(Client):
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_guid_for_name(name, server_name, time_out)
+            self._async_get_guid_for_name(
+                name,
+                property_name,
+                for_lineage,
+                for_duplicate_processing,
+                effective_time,
+                server_name,
+                time_out,
+            )
         )
         return response
 
@@ -4199,7 +4385,7 @@ class ClassificationManager(Client):
         time_out: int = default_time_out,
     ) -> None:
         """
-        Add or replace the security tags for an element. Async versuib,
+        Add or replace the security tags for an element. Async version,
 
         Security Tags: https://egeria-project.org/types/4/0423-Security-Definitions/
 

{pyegeria-0.8.4.9.dist-info → pyegeria-0.8.4.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.8.4.9
+Version: 0.8.4.10
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0