pyegeria 0.3.7__py3-none-any.whl → 0.3.8__py3-none-any.whl

pyegeria/__init__.py

@@ -43,4 +43,5 @@ from .server_operations import ServerOps
 from .collection_manager_omvs import CollectionManager
 from .project_manager_omvs import ProjectManager
 from .valid_metadata_omvs import ValidMetadataManager
-__version__ = "0.3"
+from .loaded_resources_omvs import LoadedResources
+__version__ = "0.38"

pyegeria/loaded_resources_omvs.py

@@ -0,0 +1,159 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This module allows users to query the available (registered) capabilities of Egeria. Detailed information is returned
+to provide both insight and understanding in how to use these capabilities. For example, when configuring an Egeria
+integration service, it is importregistered_info.pyant to know what companion service it depends on so that you can make sure the
+companion service is also configured and running.
+
+"""
+
+import pandas as pd
+from tabulate import tabulate
+
+from pyegeria._client import Client
+from pyegeria.utils import wrap_text
+
+
+class LoadedResources(Client):
+    """ Client to search and retrieve currently loaded information about connectors, templates, governance actions,
+        etc.
+
+    Attributes:
+    ----------
+        server_name: str
+                Name of the 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.
+
+    Methods:
+    -------
+
+    """
+
+    admin_command_root: str
+
+    def __init__(
+            self,
+            server_name: str,
+            platform_url: str,
+            user_id: str,
+            user_pwd: str = None,
+            verify_flag: bool = False,
+    ):
+        if server_name is None:
+            server_name = "NA"
+        Client.__init__(self, server_name, platform_url,
+                        user_id, user_pwd, verify_flag)
+
+    def get_all_templates(self, server: str = None, start_from: int = 0, page_size: int = 0) -> list | str:
+        """ Get Loaded templates for the Server.
+
+           Parameters
+           ----------
+
+           Returns
+           -------
+           dict | str
+              A dictionary containing a simplified list of key template attributes.
+
+           Raises
+           ------
+           InvalidParameterException
+               If the response code is not 200.
+           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
+
+           """
+        server = self.server_name if server is None else server
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/framework-services/asset-owner/open-metadata-store/"
+               f"users/{self.user_id}/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size")
+        body = {
+                  "class" : "SearchStringRequestBody",
+                  "searchString" : ".*Template.*"
+                }
+        response = self.make_request("POST", url, body)
+        return response.json().get("elementList", "No elements")
+
+    def list_severity_definitions(self, fmt: str = 'json', skinny: bool = True, wrap_len: int = 30) -> list | str:
+        """ Get the registered severities for the OMAG Server
+
+          Parameters
+          ----------
+           fmt: str, optional, default = 'json'
+               If fmt is 'json', then return the result as a JSON string. If fmt is 'table', then
+               return the result as a nicely formatted table string.
+           skinny: bool, optional, default = True
+               If a table is being created and `skinny` is true, then return a subset of the information,
+               if false return all columns.
+           wrap_len: int, optional, default = 30
+               If a table is being created, the width of the column to wrap text to.
+
+          Returns
+          -------
+          dict | str
+              If fmt is 'JSON' then return a dictionary containing the registered services for the specified
+               platform. If fmt is 'table' then return the result as a nicely formatted printable table string.
+
+          Raises
+          ------
+          InvalidParameterException
+              If the response code is not 200.
+          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
+
+        """
+        url = (f"{self.platform_url}/servers/{self.server_name}/open-metadata/repository-services"
+               f"/users/{self.user_id}/audit-log/severity-definitions"
+               )
+        response = self.make_request("GET", url)
+        if fmt == 'json':
+            return response.json().get("severities", "No severities found")
+        elif fmt == 'table':
+            df = pd.DataFrame(response.json().get("severities", []))
+            if skinny:
+                df = df.drop(columns=['ordinal'])
+            return tabulate(wrap_text(df, wrap_len=wrap_len), headers='keys', tablefmt='psql')
+
+    def list_asset_types(self, server: str = None) -> list | str:
+        """ Get the registered severities for the OMAG Server
+
+          Parameters
+          ----------
+           server: str, optional, default = None
+
+          Returns
+          -------
+          dict | str
+              Returns a list of the asset types.
+
+          Raises
+          ------
+          InvalidParameterException
+              If the response code is not 200.
+          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
+
+        """
+        server = self.server_name if server is None else server
+        url = f"{self.platform_url}/servers/{self.server_name}/api/open-metadata/asset-catalog/assets/types"
+
+        response = self.make_request("GET", url)
+        return response.json().get('types', 'no types found')

pyegeria/my_profile_omvs.py

@@ -721,7 +721,7 @@ class MyProfile(Client):
         loop.run_until_complete(self._async_reassign_to_do(todo_guid, actor_guid, status, server_name))
         return
 
-    async def _async_find_to_do(self, search_string: str = "*", server_name: str = "None", status: str = None,
+    async def _async_find_to_do(self, search_string: str = "*", server_name: str = "None", status: str = "OPEN",
                                 starts_with: bool = False, ends_with: bool = False, ignore_case: bool = True,
                                 start_from: int = 0, page_size: int = 100) -> list | str:
         """ find To-Do items. Async version.
@@ -765,7 +765,8 @@ class MyProfile(Client):
             search_string = " "
 
         body = {
-            "status": status,
+            "class": "ToDoStatusSearchString",
+            "toDoStatus": status,
             "searchString": search_string
         }
 
@@ -777,10 +778,10 @@ class MyProfile(Client):
 
         response = await self._async_make_request("POST", url, body)
         # return response.text
-        return response.json().get("toDoElements", "No guid returned")
+        return response.json().get("toDoElements", "No ToDos found")
 
     def find_to_do(self, search_string: str, server_name: str = None, status: str = "OPEN",
-                   starts_with: bool = True, ends_with: bool = False, ignore_case: bool = False,
+                   starts_with: bool = False, ends_with: bool = False, ignore_case: bool = True,
                    start_from: int = 0, page_size: int = 100) -> list | str:
         """ find To-Do items.
             Parameters
@@ -865,7 +866,7 @@ class MyProfile(Client):
                f"{todo_type}?startFrom={start_from}&pageSize={page_size}")
 
         response = await self._async_make_request("POST", url, body)
-        return response.text if response is not None else "No Results"
+        return response.json().get("toDoElements","No ToDos found")
 
     def get_to_dos_by_type(self, todo_type: str,  server_name: str = None, status: str = "OPEN",
                            start_from: int = 0, page_size: int = 100) -> list | str:

pyegeria/registered_info.py

@@ -6,7 +6,7 @@ Copyright Contributors to the ODPi Egeria project.
 
 This module allows users to query the available (registered) capabilities of Egeria. Detailed information is returned
 to provide both insight and understanding in how to use these capabilities. For example, when configuring an Egeria
-integration service, it is important to know what companion service it depends on so that you can make sure the
+integration service, it is importregistered_info.pyant to know what companion service it depends on so that you can make sure the
 companion service is also configured and running.
 
 """

{pyegeria-0.3.7.data → pyegeria-0.3.8.data}/scripts/engine_action_status.py

@@ -12,6 +12,7 @@ A simple status display for Engine Actions
 import argparse
 import json
 import time
+import sys
 
 from rich import box
 from rich.live import Live
@@ -76,7 +77,7 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
 
         token = g_client.create_egeria_bearer_token()
         action_status = g_client.get_engine_actions()
-        if "No Elements" in action_status:
+        if type(action_status) is str:
             requested_time = " "
             start_time = " "
             completion_time = " "
@@ -86,9 +87,9 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
             target_element = " "
             process_name = " "
             completion_message = " "
-        else:
+        elif type(action_status) is list:
             for action in action_status:
-                requested_time = action["requestedTime"]
+                requested_time = action.get("requestedTime", " ")
                 start_time = action.get("startTime", " ")
                 completion_time = action.get("completionTime", " ")
 
@@ -115,7 +116,9 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
                     requested_time, start_time, action_guid,engine_name, request_type,
                     action_status, target_element, completion_time, process_name, completion_message
                 )
-
+        else:
+            print("Egeria integration daemon not running")
+            sys.exit()
         # g_client.close_session()
         return table
 

{pyegeria-0.3.7.data → pyegeria-0.3.8.data}/scripts/find_todos.py

@@ -81,9 +81,9 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
         table.add_column("Status")
         table.add_column("Sponsor")
 
-        todo_items = m_client.find_to_do("*", starts_with=True)
+        todo_items = m_client.find_to_do(search_string)
 
-        if todo_items is None:
+        if type(todo_items) is str:
             name = " "
             type_name = " "
             created = " "
@@ -107,7 +107,7 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
                 sponsor = "erinoverview"
                 if status in ("WAITING", "OPEN"):
                     status = f"[yellow]{status}"
-                elif status in ("INPROGRESS", "COMPLETE"):
+                elif status in ("IN_PROGRESS", "COMPLETE"):
                     status = f"[green]{status}"
                 else:
                     status = f"[red]{status}"

{pyegeria-0.3.7.dist-info → pyegeria-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.7
+Version: 0.3.8
 Summary: A python client for Egeria
 Home-page: https://egeria-project.org/egeria-python
 Author: Dan Wolfson

{pyegeria-0.3.7.dist-info → pyegeria-0.3.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pyegeria/__init__.py,sha256=bBRHgbVWPZAt7yL150rrJm9UhELyXf8VMyycg4j3bOk,1769
+pyegeria/__init__.py,sha256=81gLQyRhtYqk5Sx5M7OD4nl0De4KeTAVCQonNpx8cTE,1821
 pyegeria/_client.py,sha256=8-8r1-_fACDEGgmfJdkeODlPmftcdiKwb-bmrSA3ac4,23606
 pyegeria/_exceptions.py,sha256=LImJPHy7MVgoH17LfqEL4ytLKcOhV7oCe66wZiDBzec,18399
 pyegeria/_globals.py,sha256=WgJ6O7_ACiAG8CUUHT_AbGgahLhO0APU8Y4rCwv9DRw,558
@@ -10,32 +10,33 @@ pyegeria/full_omag_server_config.py,sha256=sVBeG40Hp6ZG7dsz2BZqzO3bluPeu-j0fGTui
 pyegeria/glossary_omvs.py,sha256=KcKRMNgm53suqbFLqsnThln5-zzAEJ8OseexiJ8BSsk,36500
 pyegeria/gov_engine.py,sha256=3SBSZlbUTVG4x8OhlEIqipe8mB8_KEYOacHmxk7loSM,19697
 pyegeria/governance_author.py,sha256=m0wsfmyO-VxRDaPpACeIDw8eVAFu3RVbo45RPCUel9M,6340
-pyegeria/my_profile_omvs.py,sha256=gLIHiG0cO5fJKLK7EtVHtoC43WrABqDIJvdh91s_KDY,42441
+pyegeria/loaded_resources_omvs.py,sha256=ACRftAkI4Uy9HL8rMnuPO4ZWT7vVhLymKQOqbon2tcA,6226
+pyegeria/my_profile_omvs.py,sha256=0yOpGYstIDvGgFuoNFBg19ec-vRtR_84d9lFPAyN6ss,42489
 pyegeria/platform_services.py,sha256=_povbV9ezjKv9TE-QE0iceuyI8aHqzJS_am1jjLlvHs,41955
 pyegeria/project_manager_omvs.py,sha256=j-rlfoKZArghS1NPQT_sawn8Z-qvaV4MW7mwoRNeDoA,77305
-pyegeria/registered_info.py,sha256=H7mgH83JKtMeDZ1vVOWoFM9iARD38Rnb6igvfEM46AA,8775
+pyegeria/registered_info.py,sha256=j4kNzgKVWVuDBNFr3j2bA7tGSg2GBYGMDcDQm3jvFDU,8793
 pyegeria/server_operations.py,sha256=iMBfIgPGqFM1TkABqFFJDt8tVUSY2qwSrRURrmWuma0,16323
 pyegeria/utils.py,sha256=H0mew9IRcbsEi-pZfaT9HGuPO9CMOwnhOgIltyNvqTY,5240
 pyegeria/valid_metadata_omvs.py,sha256=Li_XLLIXJTN9gUqB_H1WbVpnDMSgc7ne6yuzKoBW7sU,29710
-pyegeria-0.3.7.data/scripts/collection_viewer.py,sha256=KWyOt4XeJ5ZaPrzNeMIH-qA3BeV9G7P64kAPceMsRmk,3628
-pyegeria-0.3.7.data/scripts/engine_action_status.py,sha256=vtZhXTGsZS3_xui7QLSX7aj2IWHT5TJ5Fje7CSOA6Co,5220
-pyegeria-0.3.7.data/scripts/find_todos.py,sha256=A75s7cwtXVukMCbVYFlbJoDYFg1A8fHU3dCTK2s6JtM,5171
-pyegeria-0.3.7.data/scripts/get_relationship_types.py,sha256=STySVwdbSo_nMcpYlBRqmF0DNxKwrb3621GU688jhXM,4933
-pyegeria-0.3.7.data/scripts/get_tech_details.py,sha256=Tg4UCazeEh7He9-l7yQbCuJso7ZcpaLhdmMUT866RzU,6843
-pyegeria-0.3.7.data/scripts/get_tech_types.py,sha256=xZoCrnmBXa-_WXDW3tBG6dt6IxH-aeQfg07pXM2IrsA,3924
-pyegeria-0.3.7.data/scripts/glossary_view.py,sha256=tZvdX9Sc7Q2rL9oiEjRIFFt-saqwMs8PQ3BCgp-v710,4594
-pyegeria-0.3.7.data/scripts/gov_engine_status.py,sha256=ZTVbhrvGsfzmN4j9Xz95rEMTjqTNvKi9Ojvy43Z5sI8,4000
-pyegeria-0.3.7.data/scripts/integration_daemon_status.py,sha256=9XRQKdjmYqwfxwNoo4EUhX8vrplR0etS-5Yq89lXGMw,4575
-pyegeria-0.3.7.data/scripts/list_asset_types.py,sha256=09xmGyEoScq4OeSflElhI-ThJL2RUPV6mb9zRA7UzEA,3485
-pyegeria-0.3.7.data/scripts/multi-server_status.py,sha256=XlBaIERVqYXjHO2x18WY64Oo0fUZS1onpOLAJcIlJk0,3690
-pyegeria-0.3.7.data/scripts/my_todos.py,sha256=wzGKekUAT-DfzE-R8O1_byvh0trB_FMd0YvdNkTw10Q,5660
-pyegeria-0.3.7.data/scripts/open_todos.py,sha256=f02BXZ-LgqjUOe5QiK1SKA9RDSH9m6-u_x0HTCQAD8E,4649
-pyegeria-0.3.7.data/scripts/project_list_viewer.py,sha256=yTZR0KS-PTCxDjbjkIRniWk7DR1qvUzuTGQ3eN37-7o,5434
-pyegeria-0.3.7.data/scripts/server_status.py,sha256=BgBLjYeMDN41zk9ADyPWZFBaQX0TqiCZ9pjesnByUhM,3346
-pyegeria-0.3.7.data/scripts/server_status_widget.py,sha256=tyx1I7olr6e5kJF22ou9rqsztrRDdrPCq5uVa3hhPBU,3088
-pyegeria-0.3.7.data/scripts/view_my_profile.py,sha256=KFeGAkR-DHX01jcOPOP7HMCTrAyY3i4mQKhq1dG86vE,4605
-pyegeria-0.3.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.3.7.dist-info/METADATA,sha256=rf_0Bd7zF0K5gOXRsgMxN8OmFSuY4OALk66qVbok1pM,2398
-pyegeria-0.3.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-pyegeria-0.3.7.dist-info/top_level.txt,sha256=tHowU8jow7WJGmbr4QdIk7gJWdslRgbWBiF2lMeduLQ,9
-pyegeria-0.3.7.dist-info/RECORD,,
+pyegeria-0.3.8.data/scripts/collection_viewer.py,sha256=KWyOt4XeJ5ZaPrzNeMIH-qA3BeV9G7P64kAPceMsRmk,3628
+pyegeria-0.3.8.data/scripts/engine_action_status.py,sha256=mosVQ5vI_vcGpi0gZDVZP8cQqgKVVf4jrJSHdsS5A9s,5359
+pyegeria-0.3.8.data/scripts/find_todos.py,sha256=VU6pJBJpn5O7ML2gclh1BqmppVLllVJ6lbQw-NpZsb4,5169
+pyegeria-0.3.8.data/scripts/get_relationship_types.py,sha256=STySVwdbSo_nMcpYlBRqmF0DNxKwrb3621GU688jhXM,4933
+pyegeria-0.3.8.data/scripts/get_tech_details.py,sha256=Tg4UCazeEh7He9-l7yQbCuJso7ZcpaLhdmMUT866RzU,6843
+pyegeria-0.3.8.data/scripts/get_tech_types.py,sha256=xZoCrnmBXa-_WXDW3tBG6dt6IxH-aeQfg07pXM2IrsA,3924
+pyegeria-0.3.8.data/scripts/glossary_view.py,sha256=tZvdX9Sc7Q2rL9oiEjRIFFt-saqwMs8PQ3BCgp-v710,4594
+pyegeria-0.3.8.data/scripts/gov_engine_status.py,sha256=ZTVbhrvGsfzmN4j9Xz95rEMTjqTNvKi9Ojvy43Z5sI8,4000
+pyegeria-0.3.8.data/scripts/integration_daemon_status.py,sha256=9XRQKdjmYqwfxwNoo4EUhX8vrplR0etS-5Yq89lXGMw,4575
+pyegeria-0.3.8.data/scripts/list_asset_types.py,sha256=09xmGyEoScq4OeSflElhI-ThJL2RUPV6mb9zRA7UzEA,3485
+pyegeria-0.3.8.data/scripts/multi-server_status.py,sha256=XlBaIERVqYXjHO2x18WY64Oo0fUZS1onpOLAJcIlJk0,3690
+pyegeria-0.3.8.data/scripts/my_todos.py,sha256=wzGKekUAT-DfzE-R8O1_byvh0trB_FMd0YvdNkTw10Q,5660
+pyegeria-0.3.8.data/scripts/open_todos.py,sha256=f02BXZ-LgqjUOe5QiK1SKA9RDSH9m6-u_x0HTCQAD8E,4649
+pyegeria-0.3.8.data/scripts/project_list_viewer.py,sha256=yTZR0KS-PTCxDjbjkIRniWk7DR1qvUzuTGQ3eN37-7o,5434
+pyegeria-0.3.8.data/scripts/server_status.py,sha256=BgBLjYeMDN41zk9ADyPWZFBaQX0TqiCZ9pjesnByUhM,3346
+pyegeria-0.3.8.data/scripts/server_status_widget.py,sha256=tyx1I7olr6e5kJF22ou9rqsztrRDdrPCq5uVa3hhPBU,3088
+pyegeria-0.3.8.data/scripts/view_my_profile.py,sha256=KFeGAkR-DHX01jcOPOP7HMCTrAyY3i4mQKhq1dG86vE,4605
+pyegeria-0.3.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.3.8.dist-info/METADATA,sha256=IpiRLomvSvYR48yEKcqJN9Yi1lIsQvfIhwVLsjCrHWQ,2398
+pyegeria-0.3.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pyegeria-0.3.8.dist-info/top_level.txt,sha256=tHowU8jow7WJGmbr4QdIk7gJWdslRgbWBiF2lMeduLQ,9
+pyegeria-0.3.8.dist-info/RECORD,,