pyegeria 5.2__py3-none-any.whl → 5.2.0.1__py3-none-any.whl

pyegeria/__init__.py

@@ -67,7 +67,6 @@ 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
@@ -75,7 +74,6 @@ 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,11 +693,6 @@ 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}"
@@ -710,7 +705,7 @@ class Client:
                     "effectiveTime": None,
                 }
                 url = (
-                    f"{self.platform_url}/servers/{view_server}/api/open-metadata/classification-manager/"
+                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
                     f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
                 )
 
@@ -726,7 +721,7 @@ class Client:
                     "effectiveTime": None,
                 }
                 url = (
-                    f"{self.platform_url}/servers/{view_server}/api/open-metadata/classification-manager/"
+                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
                     f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
                 )
 

pyegeria/asset_catalog_omvs.py

@@ -506,40 +506,6 @@ 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,7 +1,8 @@
 """PDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-This module provides access to the classification_manager_omvs module.
+This module contains an initial version of the classification_manager_omvs
+module.
 
 """
 
@@ -70,7 +71,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/classification-manager"
+        self.classification_command_root: str = f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/runtime-manager"
         Client.__init__(
             self,
             view_server,

pyegeria/collection_manager_omvs.py

@@ -2179,9 +2179,7 @@ class CollectionManager(Client):
 
     async def _async_get_collection_members(
         self,
-        collection_guid: str = None,
-        collection_name: str = None,
-        collection_qname: str = None,
+        collection_guid: str,
         effective_time: str = None,
         start_from: int = 0,
         page_size: int = None,
@@ -2191,16 +2189,12 @@ class CollectionManager(Client):
         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.
+            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.
+
+
+
         start_from: int, [default=0], optional
                     When multiple pages of results are available, the page number to start from.
         page_size: int, [default=None]
@@ -2226,13 +2220,7 @@ 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}"
@@ -2243,33 +2231,27 @@ class CollectionManager(Client):
 
     def get_collection_members(
         self,
-        collection_guid: str = None,
-        collection_name: str = None,
-        collection_qname: str = None,
+        collection_guid: str,
         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. Async version.
+        """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.
+
 
-               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.
+
+        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
@@ -2290,12 +2272,7 @@ class CollectionManager(Client):
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
             self._async_get_collection_members(
-                collection_guid,
-                collection_name,
-                collection_qname,
-                effective_time,
-                start_from,
-                page_size,
+                collection_guid, effective_time, start_from, page_size
             )
         )
 
@@ -2625,29 +2602,20 @@ class CollectionManager(Client):
         )
         return
 
-    async def _async_get_member_list(
-        self,
-        collection_guid: str = None,
-        collection_name: str = None,
-        collection_qname: str = None,
-    ) -> list | bool:
+    async def _async_get_member_list(self, root_collection_guid: str) -> list | bool:
         """Get the member list for the collection - async version.
         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.
+        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.
 
         Returns
         -------
-        list | str
-            The list of member information if successful, otherwise the string "No members found"
+        list | bool
+            The list of member information if successful, otherwise False.
 
         Raises
         ------
@@ -2660,20 +2628,15 @@ class CollectionManager(Client):
 
         # now find the members of the collection
         member_list = []
-        members = await self._async_get_collection_members(
-            collection_guid, collection_name, collection_qname
-        )
-        if (type(members) is str) or (len(members) == 0):
-            return "No members found"
+        members = await self._async_get_collection_members(root_collection_guid)
+        if type(members) is str:
+            return False
         # finally, construct a list of  member information
         for member_rel in members:
             member_guid = member_rel["elementHeader"]["guid"]
             member_resp = await self._async_get_collection(member_guid)
-            member = member_resp.get("element", None)
-            if member is None:
-                continue
+            member = member_resp["element"]
             # print(json.dumps(member, indent = 4))
-
             member_instance = {
                 "name": member["properties"]["name"],
                 "qualifiedName": member["properties"]["qualifiedName"],
@@ -2683,26 +2646,18 @@ class CollectionManager(Client):
             }
             member_list.append(member_instance)
 
-        return member_list if len(member_list) > 0 else "No members found"
+        return member_list
 
-    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.
+    def get_member_list(self, root_collection_guid: str) -> list | bool:
+        """Get the member list for the collection.
         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.
+        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.
+
         Returns
         -------
         list | bool
@@ -2716,9 +2671,7 @@ class CollectionManager(Client):
         """
         loop = asyncio.get_event_loop()
         resp = loop.run_until_complete(
-            self._async_get_member_list(
-                collection_guid, collection_name, collection_qname
-            )
+            self._async_get_member_list(root_collection_guid)
         )
         return resp
 

pyegeria/commands/README.md

@@ -2,8 +2,7 @@
 <!-- Copyright Contributors to the Egeria project. -->
 
 The Commands in this directory provide a simple but useful command line interface for the Egeria environment. They 
-are built with the **Rich** python package and demonstrate the use of **pyegeria**. More detailed documentation can be 
-found in the `doc` folder.
+are built with the **Rich** python package and demonstrate the use of **pyegeria** .
 
 The commands can either be invoked from one of the command line interfaces or executed directly as python scripts.
 To invoke the commands directly, install them with pipx by invoking:

pyegeria/commands/cat/__init__.py

@@ -1 +1,5 @@
-""" Placeholder """
+# from .list_glossaries import display_glossaries
+# from .list_terms import display_glossary_terms
+# from .list_deployed_catalogs import list_deployed_catalogs
+# from .list_deployed_database_schemas import list_deployed_database_schemas
+# from .list_deployed_databases import list_deployed_databases

pyegeria/commands/cat/get_collection.py

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

pyegeria/commands/cat/get_tech_type_elements.py

@@ -163,7 +163,7 @@ def main():
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
     try:
         tech_name = Prompt.ask(
-            "Enter the Asset Name to view:", default="PostgreSQL Server"
+            "Enter the Asset Name to view:", default="Apache Kafka Server"
         )
         tech_viewer(tech_name, server, url, userid, user_pass)
     except KeyboardInterrupt:

pyegeria/commands/cat/glossary_actions.py

@@ -47,8 +47,6 @@ EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
 EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
 EGERIA_WIDTH = os.environ.get("EGERIA_WIDTH", 200)
 EGERIA_JUPYTER = os.environ.get("EGERIA_JUPYTER", False)
-EGERIA_HOME_GLOSSARY_GUID = os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None)
-EGERIA_GLOSSARY_PATH = os.environ.get("EGERIA_GLOSSARY_PATH", None)
 
 
 @click.command("create-glossary")
@@ -127,7 +125,7 @@ def create_glossary(
 @click.option("--userid", default=EGERIA_USER, help="Egeria user")
 @click.option("--password", default=EGERIA_USER_PASSWORD, help="Egeria user password")
 @click.option("--timeout", default=60, help="Number of seconds to wait")
-@click.argument("glossary-guid", default=EGERIA_HOME_GLOSSARY_GUID)
+@click.argument("glossary-guid")
 def delete_glossary(server, url, userid, password, timeout, glossary_guid):
     """Delete the glossary specified"""
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
@@ -266,11 +264,8 @@ def delete_term(server, url, userid, password, timeout, term_guid):
 
 
 @click.command("import-terms")
-@click.option("--glossary_name", help="Name of Glossary", required=True)
-@click.option("--file_name", help="Path of CSV file", required=True)
-@click.option(
-    "--file_path", help="Path of CSV file", default=EGERIA_GLOSSARY_PATH, required=False
-)
+@click.option("--glossary-name", help="Name of Glossary", required=True)
+@click.option("--file-name", help="Path of CSV file", required=True)
 @click.option(
     "--verbose",
     is_flag=True,
@@ -292,7 +287,6 @@ def delete_term(server, url, userid, password, timeout, term_guid):
 @click.option("--timeout", default=60, help="Number of seconds to wait")
 def import_terms(
     glossary_name: str,
-    file_path: str,
     file_name: str,
     verbose: bool,
     upsert: bool,
@@ -307,11 +301,7 @@ def import_terms(
     token = m_client.create_egeria_bearer_token()
     try:
         result = m_client.load_terms_from_file(
-            glossary_name,
-            file_name,
-            file_path=file_path,
-            upsert=upsert,
-            verbose=verbose,
+            glossary_name, file_name, upsert=upsert, verbose=verbose
         )
 
         click.echo(
@@ -327,16 +317,8 @@ def import_terms(
 
 
 @click.command("export-terms")
-@click.option(
-    "--glossary_guid",
-    default=EGERIA_HOME_GLOSSARY_GUID,
-    help="GUID of Glossary to export",
-    required=True,
-)
-@click.option("--file_name", help="Path of CSV file", required=True)
-@click.option(
-    "--file_path", help="Path of CSV file", default=EGERIA_GLOSSARY_PATH, required=False
-)
+@click.option("--glossary-guid", help="GUID of Glossary to export", required=True)
+@click.option("--file-name", help="Path of CSV file", required=True)
 @click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use")
 @click.option(
     "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
@@ -344,14 +326,12 @@ def import_terms(
 @click.option("--userid", default=EGERIA_USER, help="Egeria user")
 @click.option("--password", default=EGERIA_USER_PASSWORD, help="Egeria user password")
 @click.option("--timeout", default=60, help="Number of seconds to wait")
-def export_terms(
-    glossary_guid: str, file_name, file_path, server, url, userid, password, timeout
-):
+def export_terms(glossary_guid: str, file_name, server, url, userid, password, timeout):
     """Export the glossary specified"""
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
-        result = m_client.export_glossary_to_csv(glossary_guid, file_name, file_path)
+        result = m_client.export_glossary_to_csv(glossary_guid, file_name)
 
         click.echo(
             f"Exported {result} terms  from glossary: {glossary_guid} into {file_name}"

pyegeria/commands/cat/list_assets.py

@@ -3,8 +3,10 @@
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-List assets
+Unit tests for the Utils helper functions using the Pytest framework.
 
+
+A simple display for glossary terms
 """
 import argparse
 import os
@@ -16,7 +18,6 @@ from rich.console import Console
 from rich.prompt import Prompt
 from rich.markdown import Markdown
 from rich.table import Table
-from rich.text import Text
 
 from pyegeria import (
     InvalidParameterException,
@@ -77,8 +78,9 @@ def display_assets(
             caption=f"View Server '{server}' @ Platform - {url}",
             expand=True,
         )
-        table.add_column("Display Name / Qualified Name / GUID", width=36)
+        table.add_column("Display Name", max_width=15)
         table.add_column("Type Name")
+        table.add_column("GUID", no_wrap=True)
         table.add_column("Technology Type")
         # table.add_column("Qualified Name",max_width=15)
         table.add_column("Matching Elements")
@@ -98,16 +100,23 @@ def display_assets(
             properties = element["properties"]
             header = element["elementHeader"]
             nested = element.get("matchingElements", "---")
-            qualified_name = properties["qualifiedName"]
-            display_name = Text(f"{properties.get("displayName", "---")}\n\n{qualified_name}\n\n"
-                                f"{header['guid']}", justify="center")
 
+            display_name = properties.get("displayName", "---")
+            # qualified_name = properties["qualifiedName"] # we decided that qualified name wasn't useful
             type_name = header["type"]["typeName"]
             tech_type = properties.get("deployedImplementationType", "---")
+            guid = header["guid"]
+            #### We decided that path wasn't useful
+            # path_name = element.get("extendedProperties", None)
+            # if path_name:
+            #     path = path_name.get("pathName"," ")
+            # else:
+            #     path = " "
+            match_md = ""
 
             match_tab = Table(expand=True)
             match_tab.add_column("Type Name")
-            match_tab.add_column("GUID", width=36)
+            match_tab.add_column("GUID", no_wrap=True, width=36)
             match_tab.add_column("Properties")
 
             for match_t in nested:
@@ -121,7 +130,7 @@ def display_assets(
                 match_details_out = Markdown(match_details_md)
                 match_tab.add_row(match_type_name, matching_guid, match_details_out)
 
-            table.add_row(display_name, type_name, tech_type, match_tab)
+            table.add_row(display_name, type_name, guid, tech_type, match_tab)
 
         g_client.close_session()
         return table

pyegeria/commands/cat/list_collections.py

@@ -7,6 +7,7 @@ A simple display for collections
 """
 import argparse
 import os
+import sys
 import time
 
 from rich import box
@@ -91,7 +92,7 @@ def display_collections(
         table.add_column("Collection Type")
 
         collections = m_client.find_collections(
-            search_string.strip(), None, False, ends_with=False, ignore_case=True
+            search_string, None, False, ends_with=False, ignore_case=True
         )
         if type(collections) is list:
             sorted_collection_list = sorted(
@@ -120,14 +121,8 @@ def display_collections(
                 force_terminal=not jupyter,
             )
             console.print(table)
-        else:
-            print("==> No collections with that name found")
-
-    except (
-        InvalidParameterException,
-        UserNotAuthorizedException,
-        PropertyServerException,
-    ) as e:
+
+    except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
     finally:
         m_client.close_session()
@@ -150,7 +145,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_catalogs.py

@@ -101,13 +101,11 @@ def list_deployed_catalogs(
         table.add_column("Catalog Schemas")
 
         if catalog_server in [None, "*"]:
-            cats = c_client.get_elements_by_classification(
-                "Anchors", "DataAccessManager"
-            )
+            cats = c_client.get_elements_by_classification("Anchors", "DataManager")
         else:
             server_guid = c_client.get_guid_for_name(catalog_server)
             cats = c_client.get_elements_by_classification_with_property_value(
-                "Anchors", server_guid, ["anchorGUID"], "DataAccessManager"
+                "Anchors", server_guid, ["anchorGUID"], "DataManager"
             )
         if type(cats) is list:
             for cat in cats: