pyegeria 0.3.9__py3-none-any.whl → 0.4.0__py3-none-any.whl

pyegeria/Xfeedback_manager_omvs.py

@@ -4,6 +4,8 @@ Copyright Contributors to the ODPi Egeria project.
 
  Feedback Manager View Service Methods - Add comments, reviews, tags and notes to elements of interest.
 
+ This work is being actively developed..
+
 """
 import asyncio
 from datetime import datetime
@@ -234,18 +236,3 @@ class FeedbackManager(Client):
         return response
 
 
-
-    async def _async_get_all_technology_types(self, server: str = None, start_from: int = 0,
-                                              page_size: int = max_paging_size) -> list | str:
-        return await self._async_find_technology_types("*", server, start_from, page_size)
-
-    def get_all_technology_types(self, server: str = None, start_from: int = 0,
-                                 page_size: int = max_paging_size) -> list | str:
-        return self.find_technology_types("*", server, start_from, page_size)
-
-
-if __name__ == "__main__":
-    p = AutomatedCuration("meow", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
-    response = p.get_active_engine_actions()
-    out = response.json()
-    print(out)

pyegeria/__init__.py

@@ -11,11 +11,14 @@ the server platform and servers.
 
 """
 
-from ._globals import is_debug, disable_ssl_warnings, max_paging_size
+from ._globals import (is_debug, disable_ssl_warnings, max_paging_size,
+                       )
+from .core_guids import *
 
 if disable_ssl_warnings:
     from urllib3.exceptions import InsecureRequestWarning
     from urllib3 import disable_warnings
+
     disable_warnings(InsecureRequestWarning)
 
 from ._exceptions import (InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
@@ -29,7 +32,7 @@ from .registered_info import RegisteredInfo
 from .glossary_browser_omvs import GlossaryBrowser
 from ._validators import (validate_user_id, validate_name, validate_guid, validate_server_name, validate_search_string,
                           validate_url, is_json, validate_public)
-# from .asset_catalog_omvs import AssetCatalog
+from .asset_catalog_omvs import AssetCatalog
 
 from .my_profile_omvs import MyProfile
 from .full_omag_server_config import FullServerConfig
@@ -37,7 +40,11 @@ from .server_operations import ServerOps
 from .collection_manager_omvs import CollectionManager
 from .project_manager_omvs import ProjectManager
 from .valid_metadata_omvs import ValidMetadataManager
-from .Xasset_catalog_omvs import AssetCatalog
+from .asset_catalog_omvs import AssetCatalog
 from .Xloaded_resources_omvs import LoadedResources
 from ._deprecated_gov_engine import GovEng
-__version__ = "0.3.9"
+from .runtime_manager_omvs import RuntimeManager
+from .action_author_omvs import GovernanceAuthor
+from .glossary_manager_omvs import GlossaryManager
+
+__version__ = "0.4"

pyegeria/_globals.py

@@ -8,10 +8,11 @@ This common file is used to set some global values and enumerations used by the
 
 """
 
+
 is_debug = False
 disable_ssl_warnings = True
 enable_ssl_check = False
-max_paging_size = 5000
+max_paging_size = 500
 
 comment_types = (
     "ANSWER",
@@ -29,3 +30,4 @@ star_ratings = (
     "THREE_STARS",
     "TWO_STARS",
 )
+

pyegeria/{Xasset_catalog_omvs.py → asset_catalog_omvs.py}

@@ -10,6 +10,7 @@ Copyright Contributors to the ODPi Egeria project.
 """
 import asyncio
 from datetime import datetime
+import json
 
 from httpx import Response
 
@@ -302,8 +303,10 @@ class AssetCatalog(Client):
     # Engine Actions
     #
 
-    async def _async_find_assets(self, search_string: str, server: str = None, start_from: int = 0,
-                                         page_size: int = max_paging_size) -> list | str:
+    async def _async_find_assets_in_domain(self, search_string: str, start_from: int = 0,
+                                          page_size: int = max_paging_size, starts_with: bool = True,
+                                          ends_with: bool = False, ignore_case: bool = True,
+                                          server: str =  None) -> list | str:
         """ Retrieve the list of engine action metadata elements that contain the search string. Async Version.
         Parameters
         ----------
@@ -345,26 +348,28 @@ class AssetCatalog(Client):
         For more information see: https://egeria-project.org/concepts/engine-action
         """
         server = self.server_name if server is None else server
-        # validate_search_string(search_string)
-        # if search_string == "*":
-        #     search_string = None
-        # starts_with_s = str(starts_with).lower()
-        # ends_with_s = str(ends_with).lower()
-        # ignore_case_s = str(ignore_case).lower()
-
-        url = (f"{self.platform_url}/servers/{server}/open-metadata/access-services/asset-owner/users/erinoverview/"
-               f"assets/by-search-string?startFrom={start_from}&pageSize={page_size}"
+        validate_search_string(search_string)
+        if search_string == "*":
+            search_string = None
+        starts_with_s = str(starts_with).lower()
+        ends_with_s = str(ends_with).lower()
+        ignore_case_s = str(ignore_case).lower()
+
+        url = (f"{self.platform_url}/servers/{server}/api/open-metadata/asset-catalog/assets/in-domain/"
+               f"by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
+               f"endWith={ends_with_s}&ignoreCase={ignore_case_s}"
                )
         body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string
+            "filter": search_string
         }
         response = await self._async_make_request("POST", url, body)
-        return response.json().get("assets", "no assets")
+        return response.json().get("searchMatches", "no assets found")
 
-    def find_assets(self, search_string: str = "*", server: str = None, start_from: int = 0,
-                            page_size: int = max_paging_size) -> list | str:
-        """ Retrieve the list of engine action metadata elements that contain the search string.
+    def find_assets_in_domain(self, search_string: str, start_from: int = 0,
+                                          page_size: int = max_paging_size, starts_with: bool = True,
+                                          ends_with: bool = False, ignore_case: bool = True,
+                                          server: str =  None) -> list | str:
+        """ Retrieve the list of engine action metadata elements that contain the search string. Async Version.
         Parameters
         ----------
         search_string : str
@@ -404,136 +409,264 @@ class AssetCatalog(Client):
         -----
         For more information see: https://egeria-project.org/concepts/engine-action
         """
-
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_find_assets(search_string, server, start_from,
-                                            page_size)
+            self._async_find_assets_in_domain(search_string,  start_from,page_size,
+                                              starts_with, ends_with, ignore_case, server)
         )
         return response
 
 
-    async def _async_find_engine_actions(self, search_string: str, server: str = None, starts_with: bool = False,
-                                         ends_with: bool = False, ignore_case: bool = False, start_from: int = 0,
-                                         page_size: int = max_paging_size) -> list | str:
-        """ Retrieve the list of engine action metadata elements that contain the search string. Async Version.
-        Parameters
-        ----------
-        search_string : str
-            The string used for searching engine actions by name.
+    async def _async_get_asset_graph(self, asset_guid:str, server: str = None, start_from: int = 0,
+                                     page_size: int = max_paging_size) -> str| dict:
+        """ Return all the elements that are anchored to an asset plus relationships between these elements and to
+            other elements. Async Version.
+           Parameters
+           ----------
+           asset_guid : str
+               The unique identity of the asset to get the graph for.
 
-        server : str, optional
-            The name of the server. If None, will use the default server specified in the instance will be used.
+           server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
 
-        starts_with : bool, optional
-            Whether to search engine actions that start with the given search string. Default is False.
+           start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
 
-        ends_with : bool, optional
-            Whether to search engine actions that end with the given search string. Default is False.
+           page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
 
-        ignore_case : bool, optional
-            Whether to ignore case while searching engine actions. Default is False.
+           Returns
+           -------
+          dict or str
+               A dictionary of the asset graph.
 
-        start_from : int, optional
-            The index from which to start fetching the engine actions. Default is 0.
+           Raises:
+           ------
+           InvalidParameterException
+           PropertyServerException
+           UserNotAuthorizedException
 
-        page_size : int, optional
-            The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+           """
+        server = self.server_name if server is None else server
 
-        Returns
-        -------
-        List[dict] or str
-            A list of dictionaries representing the engine actions found based on the search query.
-            If no actions are found, returns the string "no actions".
+        url = (f"{self.platform_url}/servers/{server}/api/open-metadata/asset-catalog/assets/{asset_guid}/"
+               f"as-graph?startFrom={start_from}&pageSize={page_size}")
 
-        Raises:
-        ------
-        InvalidParameterException
-        PropertyServerException
-        UserNotAuthorizedException
+        response = await self._async_make_request("GET", url)
+        return response.json().get("assetGraph", "no asset found")
 
-        Notes
-        -----
-        For more information see: https://egeria-project.org/concepts/engine-action
-        """
+    def get_asset_graph(self, asset_guid: str, server: str = None, start_from: int = 0,
+                               page_size: int = max_paging_size) -> str | dict:
+        """ Return all the elements that are anchored to an asset plus relationships between these elements and to
+            other elements.
+           Parameters
+           ----------
+           asset_guid : str
+               The unique identity of the asset to get the graph for.
+
+           server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
+
+           start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
+
+           page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+           Returns
+           -------
+          dict or str
+               A dictionary of the asset graph.
+
+           Raises:
+           ------
+           InvalidParameterException
+           PropertyServerException
+           UserNotAuthorizedException
+
+           """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_asset_graph(asset_guid, server,start_from, page_size)
+        )
+        return response
+
+    async def _async_get_assets_by_metadata_collection_id(self, metadata_collection_id:str, type_name: str = None,
+                                                          effective_time: str = None, server: str = None,
+                                                          start_from: int = 0, page_size: int = max_paging_size) -> str| list:
+        """ Return a list of assets that come from the requested metadata collection. Can optionally
+            specify an type name as a filter and an effective time. Async Version.
+
+            Parameters
+            ----------
+            metadata_collection_id : str
+               The unique identity of the metadata collection to return assets from.
+
+            type_name: str, optional
+                An asset type to optionally filter on. If not specified, all assets in the collection will be returned.
+
+            effective_time: str, optional
+                The effective time to filter on. If not specified, the current time is used.
+
+            server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
+
+            start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
+
+            page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+            Returns
+            -------
+           list or str
+               A list of assets in a [dict].
+
+            Raises:
+            ------
+            InvalidParameterException
+            PropertyServerException
+            UserNotAuthorizedException
+
+       """
         server = self.server_name if server is None else server
-        validate_search_string(search_string)
-        if search_string == "*":
-            search_string = None
-        starts_with_s = str(starts_with).lower()
-        ends_with_s = str(ends_with).lower()
-        ignore_case_s = str(ignore_case).lower()
 
-        url = (f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/engine-actions/"
-               f"by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
-               f"endsWith={ends_with_s}&ignoreCase={ignore_case_s}"
-               )
+        url = (f"{self.platform_url}/servers/{server}/api/open-metadata/asset-catalog/assets/by-metadata-collection-id/"
+               f"{metadata_collection_id}?startFrom={start_from}&pageSize={page_size}")
+
         body = {
-            "class": "SearchStringRequestBody",
-            "name": search_string
+            "filter": type_name,
+            "effectiveTime": effective_time
         }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("elements", "no actions")
+        body_s = body_slimmer(body)
+        print(json.dumps(body_s))
+        response = await self._async_make_request("POST", url, body_s)
+        return response.json().get("assets", "no assets found")
+
+    def get_assets_by_metadata_collection_id(self, metadata_collection_id: str, type_name: str = None,
+                                                    effective_time: str = None, server: str = None,
+                                                    start_from: int = 0,
+                                                    page_size: int = max_paging_size) -> str | list:
+        """ Return a list of assets that come from the requested metadata collection. Can optionally
+            specify an type name as a filter and an effective time. Async Version.
 
-    def find_engine_actions(self, search_string: str = "*", server: str = None, starts_with: bool = False,
-                            ends_with: bool = False, ignore_case: bool = False, start_from: int = 0,
-                            page_size: int = max_paging_size) -> list | str:
-        """ Retrieve the list of engine action metadata elements that contain the search string.
-        Parameters
-        ----------
-        search_string : str
-            The string used for searching engine actions by name.
+            Parameters
+            ----------
+            metadata_collection_id : str
+               The unique identity of the metadata collection to return assets from.
 
-        server : str, optional
-            The name of the server. If None, will use the default server specified in the instance will be used.
+            type_name: str, optional
+                An asset type to optionally filter on. If not specified, all assets in the collection will be returned.
 
-        starts_with : bool, optional
-            Whether to search engine actions that start with the given search string. Default is False.
+            effective_time: str, optional
+                The effective time to filter on. If not specified, the current time is used.
 
-        ends_with : bool, optional
-            Whether to search engine actions that end with the given search string. Default is False.
-
-        ignore_case : bool, optional
-            Whether to ignore case while searching engine actions. Default is False.
+            server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
 
-        start_from : int, optional
-            The index from which to start fetching the engine actions. Default is 0.
+            start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
 
-        page_size : int, optional
-            The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+            page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
 
-        Returns
-        -------
-        List[dict] or str
-            A list of dictionaries representing the engine actions found based on the search query.
-            If no actions are found, returns the string "no actions".
+            Returns
+            -------
+           list or str
+               A list of assets in a [dict].
 
-        Raises:
-        ------
-        InvalidParameterException
-        PropertyServerException
-        UserNotAuthorizedException
+            Raises:
+            ------
+            InvalidParameterException
+            PropertyServerException
+            UserNotAuthorizedException
 
-        Notes
-        -----
-        For more information see: https://egeria-project.org/concepts/engine-action
-        """
+       """
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_find_engine_actions(search_string, server, starts_with,
-                                            ends_with, ignore_case, start_from,
-                                            page_size)
+            self._async_get_assets_by_metadata_collection_id(metadata_collection_id, type_name,
+                                                             effective_time,server,start_from,
+                                                             page_size)
         )
         return response
 
-    async def _async_get_asset_by_guid(self, asset_guid:str, server: str = None) -> str| dict:
-        pass
+    async def _async_get_asset_catalog_types(self, server: str = None) -> str| dict:
+        """ Return all the elements that are anchored to an asset plus relationships between these elements and to
+            other elements. Async Version.
+           Parameters
+           ----------
+           asset_guid : str
+               The unique identity of the asset to get the graph for.
+
+           server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
+
+           start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
+
+           page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+           Returns
+           -------
+          dict or str
+               A dictionary of the asset graph.
+
+           Raises:
+           ------
+           InvalidParameterException
+           PropertyServerException
+           UserNotAuthorizedException
 
+           """
+        server = self.server_name if server is None else server
+
+        url = f"{self.platform_url}/servers/{server}/api/open-metadata/asset-catalog/assets/types"
+
+        response = await self._async_make_request("GET", url)
+
+        return response.json().get('types',"No assets found")
+
+    def get_asset_catalog_types(self, server: str = None) -> str | dict:
+        """ Return all the elements that are anchored to an asset plus relationships between these elements and to
+            other elements.
+           Parameters
+           ----------
+           asset_guid : str
+               The unique identity of the asset to get the graph for.
+
+           server : str, optional
+               The name of the server. If None, will use the default server specified in the instance will be used.
+
+           start_from : int, optional
+               The index from which to start fetching the engine actions. Default is 0.
 
+           page_size : int, optional
+               The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+           Returns
+           -------
+          dict or str
+               A dictionary of the asset graph.
+
+           Raises:
+           ------
+           InvalidParameterException
+           PropertyServerException
+           UserNotAuthorizedException
+
+           """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_asset_catalog_types(server)
+        )
+        return response
 
 if __name__ == "__main__":
     p = AssetCatalog("active-metadata-store", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
-    response = p.get_active_engine_actions()
+    response = p.get_assets_by_metadata_collection_id()
     out = response.json()
     print(out)