pyegeria 0.2.4__py3-none-any.whl → 0.3.0__py3-none-any.whl

pyegeria/platform_services.py

@@ -6,20 +6,23 @@ Copyright Contributors to the ODPi Egeria project.
 
 """
 
+import asyncio
 import inspect
 import json
+
 import httpx
-# import requests
 
-from pyegeria import CoreServerConfig, Client
+from pyegeria import Client
 from pyegeria._validators import validate_user_id
-from pyegeria.exceptions import (
+from pyegeria._exceptions import (
     OMAGCommonErrorCode,
     InvalidParameterException,
     UserNotAuthorizedException,
     PropertyServerException, print_exception_response,
 )
-import asyncio
+
+
+# import requests
 
 
 class Platform(Client):
@@ -88,9 +91,9 @@ class Platform(Client):
             user_id: str,
             user_pwd: str = None,
             verify_flag: bool = False,
-            sync_mode: bool = True
+
     ):
-        validate_user_id(user_id) # add this check since we aren't using bearer tokens in this class
+        validate_user_id(user_id)  # add this check since we aren't using bearer tokens in this class
 
         Client.__init__(self, server_name, platform_url, user_id, user_pwd, verify_flag)
         self.admin_command_root = (self.platform_url +
@@ -122,12 +125,15 @@ class Platform(Client):
           The principle specified by the user_id does not have authorization for the requested action
         """
 
+        global response
         calling_frame = inspect.currentframe().f_back
         caller_method = inspect.getframeinfo(calling_frame).function
         class_name = __class__.__name__
 
         url = self.admin_command_root + "/origin"
+
         local_session = httpx.Client(verify=self.ssl_verify)
+        response = " "
         try:
             response = local_session.get(url)
             if response.status_code != 200:
@@ -171,7 +177,7 @@ class Platform(Client):
                 raise InvalidParameterException(exc_msg)
             else:
                 return response.text
-        except (InvalidParameterException):
+        except InvalidParameterException:
             raise
 
         except (
@@ -246,12 +252,13 @@ class Platform(Client):
 
         await self._async_make_request("POST", url, time_out=timeout)
 
-    def activate_server_stored_config(self, server: str = None, timeout: int = 60) -> None:
+    def activate_server_stored_config(self, server: str = None, timeout: int = 90) -> None:
         """ Activate a server on the associated platform with the stored configuration.
 
         Parameters
         ----------
         server : Use the server if specified. If None, use the default server associated with the Platform object.
+        timeout: number of seconds to wait for a response before raising an exception
 
         Returns
         -------
@@ -267,10 +274,11 @@ class Platform(Client):
           The principle specified by the user_id does not have authorization for the requested action
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_activate_server_stored_config(server,timeout))
+        response = loop.run_until_complete(self._async_activate_server_stored_config(server, timeout))
         return response
 
-    async def _async_activate_server_supplied_config(self, config_body: str, server: str = None, timeout: int = 60) -> None:
+    async def _async_activate_server_supplied_config(self, config_body: dict, server: str = None, timeout: int = 60)\
+            -> None:
         """ Activate a server on the associated platform with the stored configuration. Async version.
 
         Parameters
@@ -301,7 +309,31 @@ class Platform(Client):
         url = self.admin_command_root + "/servers/" + server + "/instance/configuration"
         await self._async_make_request("POST", url, config_body, time_out=timeout)
 
-    def activate_server_supplied_config(self, config_body: str, server: str = None, timeout: int = 60) -> None:
+    def activate_server_supplied_config(self, config_body: dict, server: str = None, timeout: int = 60) -> None:
+        """ Activate a server on the associated platform with the stored configuration.
+
+            Parameters
+            ----------
+            config_body: str
+                Server configuration to use for activation.
+            server : str, optional
+                Use the server if specified. If None, use the default server associated with the Platform object.
+            timeout: int, optional
+                A request timeout in seconds
+
+            Returns
+            -------
+            None
+
+            Raises
+            ------
+            InvalidParameterException
+              If the client passes incorrect parameters on the request - such as bad URLs or invalid values
+            PropertyServerException
+              Raised by the server when an issue arises in processing a valid request
+            NotAuthorizedException
+              The principle specified by the user_id does not have authorization for the requested action
+            """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(self._async_activate_server_supplied_config(config_body, server, timeout))
 
@@ -460,7 +492,8 @@ class Platform(Client):
         Parameters
         ----------
         server : str, optional
-            The name of the server to check if configured. If not specified, the server name stored in `self.server_name` will be used.
+            The name of the server to check if configured. If not specified, the server name stored in
+            `self.server_name` will be used.
 
         Returns
         -------
@@ -471,15 +504,11 @@ class Platform(Client):
             server = self.server_name
         url = f"{self.platform_url}/open-metadata/admin-services/users/{self.user_id}/servers/{server}/configuration"
 
-        try:
-
-            response = await self._async_make_request("GET", url)
-            config = response.json().get("omagserverConfig", "No configuration found")
-            if 'auditTrail' in config:
-                return True
-            else: return False
-
-        except InvalidParameterException as e:
+        response = await self._async_make_request("GET", url)
+        config = response.json().get("omagserverConfig", "No configuration found")
+        if 'auditTrail' in config:
+            return True
+        else:
             return False
 
     def is_server_configured(self, server: str = None) -> bool:
@@ -487,7 +516,8 @@ class Platform(Client):
         Parameters
         ----------
         server : str, optional
-            The name of the server to check if configured. If not specified, the server name stored in `self.server_name` will be used.
+            The name of the server to check if configured. If not specified,
+            the server name stored in `self.server_name` will be used.
 
         Returns
         -------
@@ -499,8 +529,8 @@ class Platform(Client):
         return response
 
     async def _async_get_active_configuration(self, server: str = None) -> dict | str:
-        """
-        Return the configuration of the server if it is running. Return invalidParameter Exception if not running.
+        """  Return the configuration of the server if it is running. Return invalidParameter Exception if not running.
+             Async version.
 
         Parameters
         ----------
@@ -524,8 +554,7 @@ class Platform(Client):
         return response.json().get("omagserverConfig", "No active configuration found")
 
     def get_active_configuration(self, server: str = None) -> dict | str:
-        """
-        Return the configuration of the server if it is running. Return invalidParameter Exception if not running.
+        """ Return the configuration of the server if it is running. Return invalidParameter Exception if not running.
 
         Parameters
         ----------
@@ -599,7 +628,7 @@ class Platform(Client):
         url = self.admin_command_root + "/servers/active"
 
         response = await self._async_make_request("GET", url)
-        return response.json().get('serverList',"No servers active")
+        return response.json().get('serverList', "No servers active")
 
     def get_active_server_list(self) -> list:
         """
@@ -877,7 +906,7 @@ class Platform(Client):
         except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
             if verbose:
                 print_exception_response(e)
-            raise (e)
+            raise e
 
     def activate_server_if_down(self, server: str, verbose: bool = True, timeout: int = 60) -> bool:
         """ Activate server if it is down.
@@ -992,7 +1021,8 @@ class Platform(Client):
         is successfully activated, otherwise it returns False.
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_activate_servers_on_platform(server_list, verbose))
+        response = loop.run_until_complete(self._async_activate_servers_on_platform(server_list,
+                                                                                    verbose, timeout=timeout))
         return response
 
     async def _async_activate_platform(self, platform_name: str, hosted_server_names: [str], timeout: int = 60) -> None:
@@ -1019,9 +1049,10 @@ class Platform(Client):
 
         Notes
         -----
-        This method attempts to activate a platform by checking its status. If the platform is already active and running, it prints a message indicating so and activates any hosted servers
-        * that are down. If the platform is not active, it prints a message indicating so. If there is any exception while activating the platform or starting the servers, it prints an error
-        * message and the exception response.
+        This method attempts to activate a platform by checking its status. If the platform is already active and
+        running, it prints a message indicating so and activates any hosted servers
+        that are down. If the platform is not active, it prints a message indicating so. If there is any exception
+        while activating the platform or starting the servers, it prints an error message and the exception response.
         """
         try:
             status = self.get_platform_origin()
@@ -1067,9 +1098,10 @@ class Platform(Client):
 
         Notes
         -----
-        This method attempts to activate a platform by checking its status. If the platform is already active and running, it prints a message indicating so and activates any hosted servers
-        * that are down. If the platform is not active, it prints a message indicating so. If there is any exception while activating the platform or starting the servers, it prints an error
-        * message and the exception response.
+        This method attempts to activate a platform by checking its status. If the platform is already active and
+        running, it prints a message indicating so and activates any hosted servers
+        that are down. If the platform is not active, it prints a message indicating so. If there is any exception
+        while activating the platform or starting the servers, it prints an error message and the exception response.
         """
         loop = asyncio.get_event_loop()
         loop.run_until_complete(self._async_activate_platform(platform_name, hosted_server_names, timeout))

pyegeria/server_operations.py

@@ -6,13 +6,13 @@ Copyright Contributors to the ODPi Egeria project.
 
 """
 
+import asyncio
+
 from requests import Response
 
-from pyegeria.exceptions import (
-    InvalidParameterException,
-)
 from pyegeria import Platform
-import asyncio
+from pyegeria._validators import validate_name
+
 
 class ServerOps(Platform):
     """
@@ -32,15 +32,8 @@ class ServerOps(Platform):
             Defaults to False.
 
     Methods:
-        __init__(self,
-                 platform_url: str,
-                 end_user_id: str,
-                 )
-         Initializes the connection - throwing an exception if there is a problem
 
     """
-
-
     def __init__(
             self,
             server_name: str,
@@ -50,10 +43,7 @@ class ServerOps(Platform):
             verify_flag: bool = False,
     ):
         Platform.__init__(self, server_name, platform_url, user_id, user_pwd, verify_flag)
-        self.ops_command_root = (self.platform_url +
-                                   "/open-metadata/server-operations/users/" +
-                                   user_id)
-
+        self.ops_command_root = f"{self.platform_url}/open-metadata/server-operations/users/{user_id}"
 
     async def _async_get_active_configuration(self, server: str = None) -> dict | str:
         """
@@ -97,9 +87,9 @@ class ServerOps(Platform):
         response = loop.run_until_complete(self._async_get_active_configuration(server))
         return response
 
-
-
-
+#
+#   Archive Files
+#
     async def _async_add_archive_file(self, archive_file: str, server: str = None) -> None:
         """
         Load the server with the contents of the indicated archive file.
@@ -172,7 +162,6 @@ class ServerOps(Platform):
         )
         await self._async_make_request("POST-DATA", url, archive_connection)
 
-
     def add_archive(self, archive_connection: str, server: str = None) -> None:
         """
         Load the server with the contents of the indicated archive file.
@@ -192,9 +181,12 @@ class ServerOps(Platform):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_add_archive_file(archive_connection,server))
+        loop.run_until_complete(self._async_add_archive_file(archive_connection, server))
+#
+#   Server Ops
+#
 
-    async def _async_get_active_server_status(self, server:str = None) -> dict:
+    async def _async_get_active_server_status(self, server: str = None) -> dict:
         """  Get the status for the specified server.
 
         Parameters
@@ -289,12 +281,16 @@ class ServerOps(Platform):
         response = loop.run_until_complete(self._async_get_active_service_list_for_server(server))
         return response
 
+#
+#   Governance Engine Ops
+#
     async def _async_get_governance_engine_summaries(self, server: str = None) -> dict:
         """ Get Governance Engine Summaries. Async version.
         Parameters
         ----------
         server : str, optional
-            The name of the server to get governance engine summaries from. If not provided, the default server name will be used.
+            The name of the server to get governance engine summaries from. If not provided,
+            the default server name will be used.
 
         Returns
         -------
@@ -315,7 +311,8 @@ class ServerOps(Platform):
         Parameters
         ----------
         server : str, optional
-            The name of the server to get governance engine summaries from. If not provided, the default server name will be used.
+            The name of the server to get governance engine summaries from. If not provided,
+            the default server name will be used.
 
         Returns
         -------
@@ -326,8 +323,9 @@ class ServerOps(Platform):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(self._async_get_governance_engine_summaries(server))
         return response
+
 #
-# Integration Daemon
+# Integration Daemon Ops
 #
     async def _async_get_integration_daemon_status(self, server: str = None) -> dict | str:
         """ Get the current status of the integration daemon. Async version.
@@ -349,10 +347,79 @@ class ServerOps(Platform):
         response = loop.run_until_complete(self._async_get_integration_daemon_status(server))
         return response
 
-    def get_integration_connector_status(self, server: str = None)-> list:
+    async def _async_get_connector_config(self, connector_name: str, server: str = None) -> dict | str:
+        """ Retrieve the configuration properties of the named integration connector running in the integration daemon
+         - async version"""
+        if server is None:
+            server = self.server_name
+        validate_name(connector_name)
+
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/integration-daemon/users/{self.user_id}/"
+               f"integration-connectors/{connector_name}/configuration-properties")
+
+        response = await self._async_make_request("GET", url)
+        return response.json()
+
+    def get_connector_config(self, connector_name: str, server: str = None) -> dict | str:
+        """ Retrieve the configuration properties of the named integration connector running in the integration
+        daemon"""
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(self._async_get_connector_config(connector_name, server))
+        return response
+
+    def get_integration_connector_status(self, server: str = None) -> None:
+        """ Get the current status of the integration connector. Async version."""
         response = self.get_integration_daemon_status(server)
+    # todo - finish this? (and do async)
         pass
 
+    async def _async_restart_integration_connector(self, connector_name: str, server: str = None) -> str:
+        """ Restart the integration Connector specified by connector_name or all if not specified - async"""
+
+        if server is None:
+            server = self.server_name
+
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/integration-daemon/users/"
+               f"{self.user_id}/integration-connectors/restart")
+        body = {
+            "class": "NameRequestBody",
+            "name": connector_name
+        }
+        response = await self._async_make_request("POST", url, body)
+        return response
+
+    def restart_integration_connector(self, connector_name: str, server: str = None) -> str:
+        """ Restart the integration Connector specified by connector_name or all if not specified"""
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(self._async_restart_integration_connector(connector_name,
+                                                                                     server))
+        return response
+
+    async def _async_refresh_integration_connectors(self, connector_name: str = None, server: str = None) -> None:
+        """ Issue a refresh request to all connectors running in the integration daemon, or a specific connector
+        if one is specified - async version"""
+        if server is None:
+            server = self.server_name
+
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/integration-daemon/users/"
+               f"{self.user_id}/integration-connectors/refresh")
+        if connector_name:
+            body = {
+                "class": "NameRequestBody",
+                "name": connector_name
+            }
+            await self._async_make_request("POST", url, body)
+        else:
+            await self._async_make_request("POST", url)
+
+        return
+
+    def refresh_integration_connectors(self, connector_name: str, server: str = None) -> None:
+        """ Restart the integration Connector specified by connector_name"""
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(self._async_refresh_integration_connectors(connector_name, server))
+
 
 if __name__ == "__main__":
     p = ServerOps("meow", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)

pyegeria/utils.py

@@ -7,7 +7,7 @@ General utility functions in support of the Egeria Python Client package.
 """
 import json
 import textwrap
-
+from rich import print, print_json
 import pandas as pd
 from tabulate import tabulate
 
@@ -73,16 +73,6 @@ def print_json_list_as_table(input_json, wrap_len: int = 30, tablefmt: str = "gr
     print(tabulate(wrap_text(df, wrap_len), headers="keys", tablefmt=tablefmt))
 
 
-def print_rest_request(url):
-    """
-
-    Args:
-        url:
-    """
-    print(" ")
-    print(url)
-
-
 def print_rest_request_body(body):
     """
 
@@ -90,8 +80,7 @@ def print_rest_request_body(body):
         body:
     """
     pretty_body = json.dumps(body, indent=4)
-    print(pretty_body)
-    print(" ")
+    print_json(pretty_body, indent=4, sort_keys=True)
 
 
 def print_rest_response(response):
@@ -101,9 +90,8 @@ def print_rest_response(response):
         response:
     """
     print("Returns:")
-    pretty_response = json.dumps(response, indent=4)
-    print(pretty_response)
-    print(" ")
+    pretty_body = json.dumps(response, indent=4)
+    print_json(pretty_body, indent=4, sort_keys=True)
 
 
 def print_guid_list(guids):
@@ -112,7 +100,7 @@ def print_guid_list(guids):
         print("No assets created")
     else:
         pretty_guids = json.dumps(guids, indent=4)
-        print(pretty_guids)
+        print_json(pretty_guids, indent=4, sort_keys=True)
 
 
 #

{pyegeria-0.2.4.dist-info → pyegeria-0.3.0.dist-info}/METADATA

@@ -1,25 +1,29 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.2.4
+Version: 0.3.0
 Summary: A python client for Egeria
+Home-page: https://egeria-project.org/egeria-python
+Author: Dan Wolfson
+Author-email: Dan Wolfson <dan.wolfson@pdr-associates.com>
 Project-URL: Homepage, https://github.com/odpi/egeria-python
 Project-URL: Issues, https://github.com/odpi/egeria-python/issues
-Author-email: Dan Wolfson <dan.wolfson@pdr-associates.com>
-License-File: LICENSE
-Keywords: egeria,governance,metadata
+Keywords: egeria,metadata,governance
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
-Requires-Dist: httpx~=0.26.0
-Requires-Dist: pandas~=2.2.0
-Requires-Dist: pytest~=7.4.2
-Requires-Dist: requests~=2.31.0
-Requires-Dist: rich~=13.7.1
-Requires-Dist: tabulate~=0.9.0
-Requires-Dist: urllib3~=1.26.15
-Requires-Dist: validators~=0.22.0
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests ~=2.31.0
+Requires-Dist: validators ~=0.22.0
+Requires-Dist: pytest ~=7.4.2
+Requires-Dist: urllib3 ~=1.26.15
+Requires-Dist: tabulate ~=0.9.0
+Requires-Dist: pandas ~=2.2.0
+Requires-Dist: rich ~=13.7.1
+Requires-Dist: httpx ~=0.26.0
+Provides-Extra: tests
+Requires-Dist: pytest ; extra == 'tests'
 
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project. -->
@@ -36,13 +40,13 @@ open metadata environment from python. Details about the
 open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
 
 This package is in active development. There is initial
-support for Egeria's platform services and configuration of Open Metadata and Governance servers
-along with some basic utilities. 
-Next will be additional support to configure and operate servers, followed
-by glossary support.
+support for many of Egeria's services including configuraiton, operation, and use.  This client depends on 
+Egeria 4.4 Snapshot and above - although most of the functions may work on earlier versions of Egeria as well. 
 
 The code is organized to mimic the existing Egeria Java Client structure.
 
+A new examples folder holds some useful text widgets that help to visualize the status of an Egeria deployment.
+
 All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/), 
 team calls, or via github issues in this repo. If interested in contributing,
 you can engage via the community or directly reach out to
@@ -54,4 +58,4 @@ This is a learning experience.
 
 ----
 License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the ODPi Egeria project.
+Copyright Contributors to the ODPi Egeria project.

pyegeria-0.3.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+pyegeria/__init__.py,sha256=8QttPtk6AHJb-yr47koLZNmSk1vPbjbEnbH3qRDMzj4,1601
+pyegeria/_client.py,sha256=8-8r1-_fACDEGgmfJdkeODlPmftcdiKwb-bmrSA3ac4,23606
+pyegeria/_exceptions.py,sha256=LImJPHy7MVgoH17LfqEL4ytLKcOhV7oCe66wZiDBzec,18399
+pyegeria/_globals.py,sha256=WgJ6O7_ACiAG8CUUHT_AbGgahLhO0APU8Y4rCwv9DRw,558
+pyegeria/_validators.py,sha256=DQuMsATRGxGSBtOrVtXlCgWXGhj6Nh-uqPtCsrUGLxk,12703
+pyegeria/automated_curation_omvs.py,sha256=zloY-pZ5q7SN-UoUahK7P7WVCOIRcA7e3-e8kkylbPU,99125
+pyegeria/core_omag_server_config.py,sha256=omXXox7JDYX6hlgPjNqfHBvm0nDnckXpdaIVKbOxUR8,94359
+pyegeria/full_omag_server_config.py,sha256=5rOJne_qhtqaN-4Cr9vEqVAID9RUw4hG-05uKQrPBp0,42704
+pyegeria/glossary_omvs.py,sha256=pfU-AKzVJDDu4brRZyayWXNP-SacgHXkAThblntm-eg,35897
+pyegeria/gov_engine.py,sha256=97M0qtLrJjF91nelOsRhQINw9bePRgLn1d_xe_OO_xY,19930
+pyegeria/governance_author.py,sha256=Pzg5OkxTTav9BDc56uYwD6QMlLu1lVnawZ5wWbE5c-Y,6272
+pyegeria/my_profile_omvs.py,sha256=S5gX5HUy-XIqWWFqiGxqUpzw8HCG7GP5QwSq3FhqHwo,42436
+pyegeria/platform_services.py,sha256=rsFPJfspWQZuHDi425YQck2fM8Qn-pTS_MpE8F-kpkg,43011
+pyegeria/registered_info.py,sha256=vffGbrb4nD3_mp6MfAan8pC82vRJTRHKGTbF0Giy1PM,7502
+pyegeria/server_operations.py,sha256=C37Go_EWqaBTJ8WOwNpAjiRC-1xCBdwEfrqH46CB8no,16273
+pyegeria/utils.py,sha256=H0mew9IRcbsEi-pZfaT9HGuPO9CMOwnhOgIltyNvqTY,5240
+pyegeria-0.3.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.3.0.dist-info/METADATA,sha256=3TwG8gfh3ARLJFKYbfe8ZoTbG_35EFsvGhatqoaL5Js,2429
+pyegeria-0.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pyegeria-0.3.0.dist-info/top_level.txt,sha256=tHowU8jow7WJGmbr4QdIk7gJWdslRgbWBiF2lMeduLQ,9
+pyegeria-0.3.0.dist-info/RECORD,,

{pyegeria-0.2.4.dist-info → pyegeria-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.21.1
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

pyegeria-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyegeria

pyegeria/config.toml

@@ -1,11 +0,0 @@
-
-# SPDX-License-Identifier: Apache-2.0
-# Copyright Contributors to the ODPi Egeria project.
-
-# config.toml for connected_asset_client_base
-
-[egeria_platform]
-url = "https://localhost:9443"
-
-[config]
-isDebug = false