pyegeria 5.2.0.5__py3-none-any.whl → 5.2.0.7__py3-none-any.whl

pyegeria/__init__.py

@@ -67,6 +67,7 @@ from .glossary_manager_omvs import GlossaryManager
 from .create_tech_guid_lists import build_global_guid_lists
 from .classification_manager_omvs import ClassificationManager
 from .feedback_manager_omvs import FeedbackManager
+from .metadata_explorer_omvs import MetadataExplorer
 from .mermaid_utilities import load_mermaid, render_mermaid, generate_process_graph
 from .egeria_my_client import EgeriaMy
 from .egeria_cat_client import EgeriaCat
@@ -74,6 +75,7 @@ from .egeria_tech_client import EgeriaTech
 from .egeria_config_client import EgeriaConfig
 from .egeria_client import Egeria
 
+
 #
 # The following assignments were generated by the `create_tech_guid_lists.py` utility that uses the pyegeria functions
 # to interrogate Egeria (and the Core Content Pack) for the GUIDS associates with integration connectors and templates.

pyegeria/_client.py

@@ -693,6 +693,11 @@ class Client:
             result = await self._async_make_request("POST", url, body_slimmer(body))
             return result.json().get("guid", "No elements found")
 
+        try:
+            view_server = self.view_server
+        except AttributeError:
+            view_server = os.environ.get("VIEW_SERVER", "view-server")
+
         if (not qualified_name) and display_name:
             if (tech_type) and (property_name == "qualifiedName"):
                 name = f"{tech_type}:{display_name}"
@@ -705,7 +710,7 @@ class Client:
                     "effectiveTime": None,
                 }
                 url = (
-                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
+                    f"{self.platform_url}/servers/{view_server}/api/open-metadata/classification-manager/"
                     f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
                 )
 
@@ -721,7 +726,7 @@ class Client:
                     "effectiveTime": None,
                 }
                 url = (
-                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
+                    f"{self.platform_url}/servers/{view_server}/api/open-metadata/classification-manager/"
                     f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
                 )
 

pyegeria/asset_catalog_omvs.py

@@ -506,6 +506,40 @@ class AssetCatalog(Client):
         )
         return response
 
+    def get_asset_mermaid_graph(
+        self,
+        asset_guid: str,
+        start_from: int = 0,
+        page_size: int = max_paging_size,
+    ) -> str:
+        """Return the asset graph as mermaid markdown string.
+         Parameters
+         ----------
+         asset_guid : str
+             The unique identity of the asset to get the graph for.
+
+         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
+         -------
+        str
+             A mermaid string representing the asset graph.
+
+         Raises:
+         ------
+         InvalidParameterException
+         PropertyServerException
+         UserNotAuthorizedException
+
+        """
+
+        asset_graph = self.get_asset_graph(asset_guid, start_from, page_size)
+        return asset_graph.get("mermaidGraph")
+
     async def _async_get_asset_lineage_graph(
         self,
         asset_guid: str,

pyegeria/classification_manager_omvs.py

@@ -1,8 +1,7 @@
 """PDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-This module contains an initial version of the classification_manager_omvs
-module.
+This module provides access to the classification_manager_omvs module.
 
 """
 
@@ -71,7 +70,7 @@ class ClassificationManager(Client):
         self.platform_url = platform_url
         self.user_id = user_id
         self.user_pwd = user_pwd
-        self.classification_command_root: str = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager"
+        self.classification_command_root: str = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager"
         Client.__init__(
             self,
             view_server,

pyegeria/collection_manager_omvs.py

@@ -2179,7 +2179,9 @@ class CollectionManager(Client):
 
     async def _async_get_collection_members(
         self,
-        collection_guid: str,
+        collection_guid: str = None,
+        collection_name: str = None,
+        collection_qname: str = None,
         effective_time: str = None,
         start_from: int = 0,
         page_size: int = None,
@@ -2189,12 +2191,16 @@ class CollectionManager(Client):
         Parameters
         ----------
         collection_guid: str,
-            identity of the collection to return members for.
+            identity of the collection to return members for. If none, collection_name or
+            collection_qname are used.
+        collection_name: str,
+            display name of the collection to return members for. If none, collection_guid
+            or collection_qname are used.
+        collection_qname: str,
+            qualified name of the collection to return members for. If none, collection_guid
+            or collection_name are used.
         effective_time: str, [default=None], optional
             Effective time of the query. If not specified will default to any time.
-
-
-
         start_from: int, [default=0], optional
                     When multiple pages of results are available, the page number to start from.
         page_size: int, [default=None]
@@ -2220,7 +2226,13 @@ class CollectionManager(Client):
 
         if page_size is None:
             page_size = self.page_size
-
+        collection_guid = self.__get_guid__(
+            collection_guid,
+            collection_name,
+            "name",
+            collection_qname,
+            None,
+        )
         url = (
             f"{self.collection_command_root}/{collection_guid}/"
             f"members?startFrom={start_from}&pageSize={page_size}"
@@ -2231,27 +2243,33 @@ class CollectionManager(Client):
 
     def get_collection_members(
         self,
-        collection_guid: str,
+        collection_guid: str = None,
+        collection_name: str = None,
+        collection_qname: str = None,
         effective_time: str = None,
         start_from: int = 0,
         page_size: int = None,
     ) -> list | str:
-        """Return a list of elements that are a member of a collection.
-
-        Parameters
-        ----------
-        collection_guid: str,
-            identity of the collection to return members for.
-        effective_time: str, [default=None], optional
-            Effective time of the query. If not specified will default to any time.
-
-
+        """Return a list of elements that are a member of a collection. Async version.
 
-        start_from: int, [default=0], optional
-                    When multiple pages of results are available, the page number to start from.
-        page_size: int, [default=None]
-            The number of items to return in a single page. If not specified, the default will be taken from
-            the class instance.
+               Parameters
+               ----------
+               collection_guid: str,
+                   identity of the collection to return members for. If none, collection_name or
+                   collection_qname are used.
+               collection_name: str,
+                   display name of the collection to return members for. If none, collection_guid
+                   or collection_qname are used.
+               collection_qname: str,
+                   qualified name of the collection to return members for. If none, collection_guid
+                   or collection_name are used.
+               effective_time: str, [default=None], optional
+                   Effective time of the query. If not specified will default to any time.
+               start_from: int, [default=0], optional
+                           When multiple pages of results are available, the page number to start from.
+               page_size: int, [default=None]
+                   The number of items to return in a single page. If not specified, the default will be taken from
+                   the class instance.
         Returns
         -------
         List | str
@@ -2272,7 +2290,12 @@ class CollectionManager(Client):
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
             self._async_get_collection_members(
-                collection_guid, effective_time, start_from, page_size
+                collection_guid,
+                collection_name,
+                collection_qname,
+                effective_time,
+                start_from,
+                page_size,
             )
         )
 
@@ -2602,15 +2625,24 @@ class CollectionManager(Client):
         )
         return
 
-    async def _async_get_member_list(self, root_collection_guid: str) -> list | bool:
+    async def _async_get_member_list(
+        self,
+        collection_guid: str = None,
+        collection_name: str = None,
+        collection_qname: str = None,
+    ) -> list | bool:
         """Get the member list for the collection - async version.
         Parameters
         ----------
-        root_collection_guid : str
-            The unique GUID of the root collection.
-
-
-            The name of the server. If not provided, the default server name will be used.
+        collection_guid: str,
+           identity of the collection to return members for. If none, collection_name or
+           collection_qname are used.
+        collection_name: str,
+           display name of the collection to return members for. If none, collection_guid
+           or collection_qname are used.
+        collection_qname: str,
+           qualified name of the collection to return members for. If none, collection_guid
+           or collection_name are used.
 
         Returns
         -------
@@ -2628,7 +2660,9 @@ class CollectionManager(Client):
 
         # now find the members of the collection
         member_list = []
-        members = await self._async_get_collection_members(root_collection_guid)
+        members = await self._async_get_collection_members(
+            collection_guid, collection_name, collection_qname
+        )
         if type(members) is str:
             return False
         # finally, construct a list of  member information
@@ -2648,16 +2682,24 @@ class CollectionManager(Client):
 
         return member_list
 
-    def get_member_list(self, root_collection_guid: str) -> list | bool:
-        """Get the member list for the collection.
+    def get_member_list(
+        self,
+        collection_guid: str = None,
+        collection_name: str = None,
+        collection_qname: str = None,
+    ) -> list | bool:
+        """Get the member list for the collection - async version.
         Parameters
         ----------
-        root_collection_guid : str
-            The GUID of the root collection.
-
-
-            The name of the server. If not provided, the default server name will be used.
-
+        collection_guid: str,
+           identity of the collection to return members for. If none, collection_name or
+           collection_qname are used.
+        collection_name: str,
+           display name of the collection to return members for. If none, collection_guid
+           or collection_qname are used.
+        collection_qname: str,
+           qualified name of the collection to return members for. If none, collection_guid
+           or collection_name are used.
         Returns
         -------
         list | bool
@@ -2671,7 +2713,9 @@ class CollectionManager(Client):
         """
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
-            self._async_get_member_list(root_collection_guid)
+            self._async_get_member_list(
+                collection_guid, collection_name, collection_qname
+            )
         )
         return resp
 

pyegeria/commands/cat/get_collection.py

@@ -54,11 +54,17 @@ def collection_viewer(
     """A simple collection viewer"""
 
     def walk_collection_hierarchy(
-        collection_client: CollectionManager, root_collection_name: str, tree: Tree
+        tree: Tree,
+        collection_client: CollectionManager,
+        root_collection_guid: str = None,
+        root_collection_name: str = None,
+        root_collection_qname: str = None,
     ) -> None:
         """Recursively build a Tree with collection contents."""
-        members = collection_client.get_member_list(root_collection_name)
-        if members:
+        members = collection_client.get_member_list(
+            root_collection_guid, root_collection_name, root_collection_qname
+        )
+        if type(members) is list:
             for member in members:
                 style = "bold white on black"
                 text_collection_name = Text(
@@ -78,29 +84,27 @@ def collection_viewer(
                 )
                 tt = tree.add(p, style=style)
 
-                children = collection_client.get_collection_members(member["guid"])
+                children = collection_client.get_collection_members(
+                    collection_guid=member["guid"]
+                )
                 if type(children) is list:
                     branch = tt.add(
                         f"[bold magenta on black]Members",
                         style=style,
                         guide_style=style,
                     )
-                    walk_collection_hierarchy(
-                        collection_client, member["qualifiedName"], branch
-                    ),
+                    walk_collection_hierarchy(branch, collection_client, member["guid"])
         else:
             tt = tree.add(
                 f"[bold magenta on black]No collections match {root_collection_name}"
             )
 
     try:
-        tree = Tree(
-            f"[bold bright green on black]{root}", guide_style="bold bright_blue"
-        )
+        tree = Tree(f"[bold bright green]{root}", guide_style="bold bright_blue")
         c_client = CollectionManager(server_name, platform_url, user_id=user)
 
         token = c_client.create_egeria_bearer_token(user, user_password)
-        walk_collection_hierarchy(c_client, root, tree)
+        walk_collection_hierarchy(tree, c_client, None, root)
         print(tree)
 
     except (
@@ -108,7 +112,12 @@ def collection_viewer(
         PropertyServerException,
         UserNotAuthorizedException,
     ) as e:
-        print_exception_response(e)
+        if e.exception_error_message_parameters[1] == "No elements found":
+            print("The collection was not found.")
+        else:
+            print_exception_response(e)
+    finally:
+        c_client.close_session()
 
 
 def main():
@@ -128,7 +137,7 @@ def main():
     try:
         root_collection = Prompt.ask(
             "Enter the Root Collection to start from:",
-            default="Root Sustainability Collection",
+            default="Digital Products Root",
         )
         collection_viewer(root_collection, server, url, userid, user_pass)
     except KeyboardInterrupt:

pyegeria/commands/cat/list_collections.py

@@ -7,7 +7,6 @@ A simple display for collections
 """
 import argparse
 import os
-import sys
 import time
 
 from rich import box
@@ -92,7 +91,7 @@ def display_collections(
         table.add_column("Collection Type")
 
         collections = m_client.find_collections(
-            search_string, None, False, ends_with=False, ignore_case=True
+            search_string.strip(), None, False, ends_with=False, ignore_case=True
         )
         if type(collections) is list:
             sorted_collection_list = sorted(
@@ -121,8 +120,14 @@ def display_collections(
                 force_terminal=not jupyter,
             )
             console.print(table)
-
-    except (InvalidParameterException, PropertyServerException) as e:
+        else:
+            print("==> No collections with that name found")
+
+    except (
+        InvalidParameterException,
+        UserNotAuthorizedException,
+        PropertyServerException,
+    ) as e:
         print_exception_response(e)
     finally:
         m_client.close_session()
@@ -145,7 +150,7 @@ def main():
     try:
         search_string = Prompt.ask(
             "Enter the collection you are searching for or '*' for all:", default="*"
-        )
+        ).strip()
 
         display_collections(search_string, server, url, userid, user_pass)
 

pyegeria/commands/cat/list_deployed_database_schemas.py

@@ -87,7 +87,7 @@ def list_deployed_database_schemas(
     def generate_table() -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Database Schema List @ {time.asctime()}",
+            title=f"Catalog Schema List @ {time.asctime()}",
             caption=f"Databases found: {view_url} - {view_server} @ {time.asctime()}",
             style="bold bright_white on black",
             row_styles=["bold bright_white on black"],
@@ -96,17 +96,12 @@ def list_deployed_database_schemas(
             caption_style="white on black",
             show_lines=True,
             box=box.ROUNDED,
-            # title=f"Elements for Open Metadata Type: '{om_type}' ",
             expand=True,
             # width=500
         )
 
         table.add_column("Schema in Catalog")
         table.add_column("Schema Properties")
-
-        # table.add_column("Home Store")
-        # table.add_column("GUID", width=38, no_wrap=True)
-        # table.add_column("Properties")
         table.add_column("Cataloged Resource")
 
         om_type = "DeployedDatabaseSchema"
@@ -139,18 +134,21 @@ def list_deployed_database_schemas(
             # get the information about the catalog we are part of
             el_classification = header["classifications"]
             for c in el_classification:
+                el_cat_guid = "---"
                 if c["type"]["typeName"] == "Anchors":
                     el_anchor_guid = c["classificationProperties"]["anchorGUID"]
                     el_anchor_type_name = c["classificationProperties"][
                         "anchorTypeName"
                     ]
-                    if el_anchor_type_name == "Catalog":
+                    el_anchor_domain_name = c["classificationProperties"][
+                        "anchorDomainName"
+                    ]
+                    el_cat_name = "---"
+                    if el_anchor_domain_name == "SoftwareCapability":
                         el_cat = c_client.get_element_by_guid(el_anchor_guid)
                         el_cat_name = el_cat["properties"].get("name", None)
                         if el_cat_name is None:
-                            el_cat_name = el_cat["properties"].get(
-                                "qualifiedName", "---"
-                            )
+                            el_cat_name = el_cat["properties"].get("qualifiedName", "")
                         el_cat_guid = el_cat["elementHeader"]["guid"]
             el_schema_id = (
                 f"{el_name}\n{el_guid}\n\n\t\tin\n\n{el_cat_name}\n{el_cat_guid}"
@@ -203,10 +201,6 @@ def list_deployed_database_schemas(
 
             table.add_row(
                 el_schema_id,
-                # el_type,
-                # el_created_out,
-                # el_home,
-                # el_guid,
                 el_props_out,
                 rel_el_out,
             )