pyegeria 1.5.1.1.60__py3-none-any.whl → 5.2__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,20 +2625,29 @@ 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
         -------
-        list | bool
-            The list of member information if successful, otherwise False.
+        list | str
+            The list of member information if successful, otherwise the string "No members found"
 
         Raises
         ------
@@ -2628,15 +2660,20 @@ class CollectionManager(Client):
 
         # now find the members of the collection
         member_list = []
-        members = await self._async_get_collection_members(root_collection_guid)
-        if type(members) is str:
-            return False
+        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"
         # 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["element"]
+            member = member_resp.get("element", None)
+            if member is None:
+                continue
             # print(json.dumps(member, indent = 4))
+
             member_instance = {
                 "name": member["properties"]["name"],
                 "qualifiedName": member["properties"]["qualifiedName"],
@@ -2646,18 +2683,26 @@ class CollectionManager(Client):
             }
             member_list.append(member_instance)
 
-        return member_list
+        return member_list if len(member_list) > 0 else "No members found"
 
-    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 +2716,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/README.md

@@ -2,7 +2,8 @@
 <!-- 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** .
+are built with the **Rich** python package and demonstrate the use of **pyegeria**. More detailed documentation can be 
+found in the `doc` folder.
 
 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,5 +1 @@
-# 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
+""" Placeholder """

pyegeria/commands/cat/exp_list_glossaries.py

@@ -0,0 +1,156 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box, print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+from rich_pixels import Pixels
+
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    EgeriaTech,
+    print_exception_response,
+)
+
+disable_ssl_warnings = True
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_glossaries(
+    search_string: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    """Display either a specified glossary or all glossaries if the search_string is '*'.
+    Parameters
+    ----------
+    search_string : str, default is '*'
+        The string used to search for glossaries.
+    view_server : str
+        The view server name or address where the Egeria services are hosted.
+    view_url : str
+        The URL of the platform the view server is on.
+    user : str
+        The user ID for authentication with the Egeria server.
+    user_pass : str
+        The password for authentication with the Egeria server.
+    jupyter : bool, optional
+        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
+    width : int, optional
+        The width of the console output (default is EGERIA_WIDTH).
+    """
+    m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        table = Table(
+            title=f"Glossary List @ {time.asctime()}",
+            style="bright_white on black",
+            header_style="bright_white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
+            expand=True,
+        )
+        table.add_column("Glossary Name")
+        table.add_column(
+            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
+        )
+        table.add_column("Language")
+
+        table.add_column("Usage", width=50, justify="center")
+
+        glossaries = m_client.find_glossaries(search_string)
+        if type(glossaries) is list:
+            sorted_glossary_list = sorted(
+                glossaries, key=lambda k: k["glossaryProperties"]["displayName"]
+            )
+            for glossary in sorted_glossary_list:
+                display_name = glossary["glossaryProperties"]["displayName"]
+                qualified_name = glossary["glossaryProperties"]["qualifiedName"]
+                guid = glossary["elementHeader"]["guid"]
+                q_name = Text(f"{qualified_name}\n&\n{guid}", justify="center")
+                language = glossary["glossaryProperties"]["language"]
+                description = glossary["glossaryProperties"]["description"]
+                usage = glossary["glossaryProperties"]["usage"]
+                text = "http://100.83.199.62:8088/superset/dashboard/p/xOgE56dLNaY/"
+
+                table.add_row(display_name, q_name, language, text)
+            console = Console(
+                style="bold bright_white on black",
+                width=width,
+                force_terminal=not jupyter,
+            )
+            console.print(table)
+            print("Visit my [link=https://www.willmcgugan.com]blog[/link]!")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        search_string = Prompt.ask(
+            "Enter the glossary you are searching for or '*' for all:", default="*"
+        )
+
+        display_glossaries(search_string, server, url, userid, user_pass)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

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}"
+                f"[bold magenta on black]No collections found in {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/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="Apache Kafka Server"
+            "Enter the Asset Name to view:", default="PostgreSQL Server"
         )
         tech_viewer(tech_name, server, url, userid, user_pass)
     except KeyboardInterrupt: