pyegeria 1.5.1.1.36__py3-none-any.whl → 1.5.1.1.38__py3-none-any.whl

pyegeria/_client.py

@@ -654,32 +654,33 @@ class Client:
                             integration_guids[display_name] = resource_guid
                             # print(f"Added {display_name} integration connector with GUID {integration_guids[display_name]}")
 
-    async def __async__get_guid__(
+    async def __async_get_guid__(
         self,
         guid: str = None,
-        name: str = None,
+        display_name: str = None,
         property_name: str = "qualifiedName",
+        qualified_name: str = None,
         tech_type: str = None,
     ) -> str:
-        """Helper function to return a server_guid - one of server_guid or server_name should
-        contain information. If both are None, an exception will be thrown. If both contain
-        values, server_guid will be used. If the tech_type is supplied and the property_name is qualifiedName
-        then the name will be pre-pended with the tech_type name to form a qualifiedName.
+        """Helper function to return a server_guid - one of server_guid, qualified_name or display_name should
+        contain information. If all are None, an exception will be thrown. If all contain
+        values, server_guid will be used first, followed by qualified_name.  If the tech_type is supplied and the
+        property_name is qualifiedName then the display_name will be pre-pended with the tech_type name to form a
+        qualifiedName.
 
         An InvalidParameter Exception is thrown if multiple matches
         are found for the given property name. If this occurs, use a qualified name for the property name.
         Async version.
         """
+
         if guid:
             return guid
-        if name:
-            if (tech_type) and (property_name == "qualifiedName"):
-                name = f"{tech_type}:{name}"
 
+        if qualified_name:
             body = {
                 "class": "NameRequestBody",
-                "name": name,
-                "namePropertyName": property_name,
+                "name": qualified_name,
+                "namePropertyName": "qualifiedName",
                 "forLineage": False,
                 "forDuplicateProcessing": False,
                 "effectiveTime": None,
@@ -689,11 +690,43 @@ class Client:
                 f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
             )
 
-            response: Response = await self._async_make_request(
-                "POST", url, body_slimmer(body), time_out=self.time_out
-            )
+            result = await self._async_make_request("POST", url, body_slimmer(body))
+            return result.json().get("guid", "No elements found")
+
+        if (not qualified_name) and display_name:
+            if (tech_type) and (property_name == "qualifiedName"):
+                name = f"{tech_type}:{display_name}"
+                body = {
+                    "class": "NameRequestBody",
+                    "name": name,
+                    "namePropertyName": property_name,
+                    "forLineage": False,
+                    "forDuplicateProcessing": False,
+                    "effectiveTime": None,
+                }
+                url = (
+                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
+                    f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
+                )
 
-            return response.json().get("guid", "No elements found")
+                result = await self._async_make_request("POST", url, body_slimmer(body))
+                return result.json().get("guid", "No elements found")
+            else:
+                body = {
+                    "class": "NameRequestBody",
+                    "name": display_name,
+                    "namePropertyName": property_name,
+                    "forLineage": False,
+                    "forDuplicateProcessing": False,
+                    "effectiveTime": None,
+                }
+                url = (
+                    f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/classification-manager/"
+                    f"elements/guid-by-unique-name?forLineage=false&forDuplicateProcessing=false"
+                )
+
+                result = await self._async_make_request("POST", url, body_slimmer(body))
+                return result.json().get("guid", "No elements found")
         else:
             raise InvalidParameterException(
                 "Neither server_guid nor server_name were provided - please provide."
@@ -702,21 +735,26 @@ class Client:
     def __get_guid__(
         self,
         guid: str = None,
-        name: str = None,
+        display_name: str = None,
         property_name: str = "qualifiedName",
+        qualified_name: str = None,
         tech_type: str = None,
     ) -> str:
-        """Helper function to return a server_guid - one of server_guid or server_name should
-        contain information. If both are None, an exception will be thrown. If both contain
-        values, server_guid will be used. If the tech_type is supplied and the property_name is qualifiedName
-        then the name will be pre-pended with the tech_type name to form a qualifiedName.
+        """Helper function to return a server_guid - one of server_guid, qualified_name or display_name should
+        contain information. If all are None, an exception will be thrown. If all contain
+        values, server_guid will be used first, followed by qualified_name.  If the tech_type is supplied and the
+        property_name is qualifiedName then the display_name will be pre-pended with the tech_type name to form a
+        qualifiedName.
 
         An InvalidParameter Exception is thrown if multiple matches
         are found for the given property name. If this occurs, use a qualified name for the property name.
+        Async version.
         """
         loop = asyncio.get_event_loop()
         result = loop.run_until_complete(
-            self.__async__get_guid__(guid, name, property_name, tech_type)
+            self.__async_get_guid__(
+                guid, display_name, property_name, qualified_name, tech_type
+            )
         )
         return result
 

pyegeria/commands/cat/glossary_actions.py

@@ -259,7 +259,7 @@ def create_term(
 def load_terms(
     glossary_name, file_name, verbose, upsert, server, url, userid, password, timeout
 ):
-    """Delete the glossary specified"""
+    """Load terms from file into the glossary specified"""
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
@@ -294,7 +294,7 @@ def load_terms(
 @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, file_name, server, url, userid, password, timeout):
-    """Delete the glossary specified"""
+    """Export the glossary specified"""
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
@@ -308,3 +308,27 @@ def export_terms(glossary_guid, file_name, server, url, userid, password, timeou
         print_exception_response(e)
     finally:
         m_client.close_session()
+
+
+@click.command("delete-term")
+@click.option("--term-guid", help="Unique identity of term", 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"
+)
+@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 delete_term(term_guid, server, url, userid, password, timeout):
+    """Delete the Term specified"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        m_client.delete_term(term_guid)
+
+        click.echo(f"Deleted term:  {term_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()

pyegeria/commands/cat/list_glossaries.py

@@ -87,7 +87,9 @@ def display_glossaries(
             expand=True,
         )
         table.add_column("Glossary Name")
-        table.add_column("Qualified Name / GUID", width=38, no_wrap=True)
+        table.add_column(
+            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
+        )
         table.add_column("Language")
         table.add_column("Description")
         table.add_column("Usage")
@@ -101,7 +103,7 @@ def display_glossaries(
                 display_name = glossary["glossaryProperties"]["displayName"]
                 qualified_name = glossary["glossaryProperties"]["qualifiedName"]
                 guid = glossary["elementHeader"]["guid"]
-                q_name = f"{qualified_name}\n\n{guid}"
+                q_name = Text(f"{qualified_name}\n&\n{guid}", justify="center")
                 language = glossary["glossaryProperties"]["language"]
                 description = glossary["glossaryProperties"]["description"]
                 usage = glossary["glossaryProperties"]["usage"]

pyegeria/commands/cat/list_servers_deployed_imp.py

@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Display by deployed implementation type.
+
+Note: This implementation is using the runtime manager.
+
+
+
+A simple server status display
+"""
+import argparse
+import os
+import sys
+import time
+
+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 pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    RuntimeManager,
+)
+
+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_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+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_servers_by_dep_imp(
+    filter: 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,
+):
+    p_client = RuntimeManager(view_server, view_url, user, user_pass)
+    token = p_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Servers by Deployed Implementation Type - {time.asctime()}",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            header_style="white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            caption=f"Platform - '{view_url}'",
+            show_lines=True,
+        )
+
+        table.add_column("Server")
+        table.add_column("Deployed Impl Type")
+        table.add_column("Zones")
+
+        table.add_column("Description")
+        table.add_column("Qualified Name & GUID", no_wrap=True)
+
+        unsorted_server_list = p_client.get_servers_by_dep_impl_type(filter)
+        if type(unsorted_server_list) is str:
+            print("No matching Software Servers found?")
+            sys.exit(1)
+        server_list = sorted(
+            unsorted_server_list,
+            key=lambda x: x["properties"].get("displayName", "---").lower(),
+        )
+
+        for server in server_list:
+            display_name = server["properties"].get("displayName", "---")
+            qualified_name = server["properties"].get("qualifiedName", "---")
+            classifications = server["elementHeader"].get("classifications", None)
+            zones = ""
+            if classifications:
+                for clas in classifications:
+                    if clas["classificationName"] == "AssetZoneMembership":
+                        classification_props = clas["classificationProperties"]
+                        zone_membership = classification_props.get(
+                            "zoneMembership", None
+                        )
+                        if zone_membership:
+                            for z in zone_membership.keys():
+                                zones += f"{zone_membership[z]}, "
+                            zones = zones[:-2]
+
+            impl_type = server["properties"].get("deployedImplementationType", "---")
+            server_guid = server["elementHeader"]["guid"]
+            server_desc = server["properties"].get("resourceDescription", "---")
+
+            server_id = Text(f"{qualified_name}\n&\n{server_guid}", justify="center")
+
+            table.add_row(display_name, impl_type, zones, server_desc, server_id)
+
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        p_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_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    filter = Prompt.ask(
+        "Filter deployed for deployed implementation type by search string", default="*"
+    )
+    display_servers_by_dep_imp(filter, server, url, userid, user_pass)
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/list_terms.py

@@ -88,10 +88,7 @@ def display_glossary_terms(
     token = g_client.create_egeria_bearer_token()
     if (glossary_name is not None) and (glossary_name != "*"):
         glossary_guid = g_client.__get_guid__(
-            glossary_guid,
-            glossary_name,
-            "qualifiedName",
-            "Glossary",
+            glossary_guid, glossary_name, "qualifiedName", None, "Glossary"
         )
 
     def generate_table(search_string: str, glossary_guid: str = None) -> Table:
@@ -141,14 +138,20 @@ def display_glossary_terms(
             if props == "None":
                 return table
 
-            display_name = Text(props["displayName"], style=style)
+            display_name = Text(props["displayName"], style=style, justify="center")
             qualified_name = props["qualifiedName"]
             term_guid = term["elementHeader"]["guid"]
-            q_name = Text(f"{qualified_name}\n\t\t&\n{term_guid}", style=style)
-            abbrev = Text(props.get("abbreviation", " "), style=style)
+            q_name = Text(
+                f"{qualified_name}\n&\n{term_guid}", style=style, justify="center"
+            )
+            abbrev = Text(props.get("abbreviation", " "), style=style, justify="center")
             summary = Text(props.get("summary", " "), style=style)
             description = Text(props.get("description", " "), style=style)
-            version = Text(props.get("publishVersionIdentifier", " "), style=style)
+            version = Text(
+                props.get("publishVersionIdentifier", " "),
+                style=style,
+                justify="center",
+            )
 
             classifications = term["elementHeader"]["classifications"]
             glossary_guid = None

pyegeria/commands/cli/egeria.py

@@ -27,6 +27,7 @@ from pyegeria.commands.cat.list_tech_types import display_tech_types
 from pyegeria.commands.cat.list_todos import display_to_dos as list_todos
 from pyegeria.commands.cat.list_user_ids import list_user_ids
 from pyegeria.commands.cat.list_archives import display_archive_list
+from pyegeria.commands.cat.list_servers_deployed_imp import display_servers_by_dep_imp
 from pyegeria.commands.cli.ops_config import Config
 from pyegeria.commands.my.list_my_profile import display_my_profile
 from pyegeria.commands.my.list_my_roles import display_my_roles
@@ -42,6 +43,7 @@ from pyegeria.commands.cat.glossary_actions import (
     delete_glossary,
     create_term,
     load_terms,
+    delete_term,
     export_terms,
 )
 from pyegeria.commands.cat.list_glossaries import display_glossaries
@@ -933,12 +935,32 @@ def archives(ctx):
     )
 
 
+@show.command("deployed-servers")
+@click.option(
+    "--search-string",
+    default="*",
+    help="Filter deployed for deployed implementation type by search string",
+)
+@click.pass_context
+def show_deployed_servers(ctx, search_string):
+    c = ctx.obj
+    display_servers_by_dep_imp(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
 @show.command("deployed-schemas")
 @click.option(
     "--search_catalog", default="*", help="What database or catalog to search"
 )
 @click.pass_context
-def deployed_schemas(search_catalog, ctx):
+def deployed_schemas(ctx, search_catalog):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_database_schemas(
@@ -955,7 +977,7 @@ def deployed_schemas(search_catalog, ctx):
 @show.command("catalogs")
 @click.option("--search_server", default="*", help="Server to search for catalogs")
 @click.pass_context
-def catalogs(search_server, ctx):
+def catalogs(ctx, search_server):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_catalogs(
@@ -1016,6 +1038,7 @@ tell.add_command(reassign_todo)
 tell.add_command(delete_todo)
 tell.add_command(create_todo)
 tell.add_command(load_terms)
+tell.add_command(delete_term)
 tell.add_command(export_terms)
 
 

pyegeria/commands/cli/egeria_cat.py

@@ -22,9 +22,11 @@ from pyegeria.commands.cat.glossary_actions import (
     create_glossary,
     delete_glossary,
     create_term,
+    delete_term,
     load_terms,
     export_terms,
 )
+from pyegeria.commands.cat.list_servers_deployed_imp import display_servers_by_dep_imp
 from pyegeria.commands.cat.list_glossaries import display_glossaries
 from pyegeria.commands.cat.list_archives import display_archive_list
 from pyegeria.commands.cat.list_assets import display_assets
@@ -516,6 +518,26 @@ def list_archives(ctx):
     )
 
 
+@show.command("deployed-servers")
+@click.option(
+    "--search-string",
+    default="*",
+    help="Filter deployed for deployed implementation type by search string",
+)
+@click.pass_context
+def show_deployed_servers(ctx, search_string):
+    c = ctx.obj
+    display_servers_by_dep_imp(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
 @show.command("deployed-schemas")
 @click.option("--catalog", default="*", help="What database or catalog to search")
 @click.pass_context
@@ -596,6 +618,7 @@ tell.add_command(mark_todo_complete)
 tell.add_command(reassign_todo)
 tell.add_command(delete_todo)
 tell.add_command(create_todo)
+tell.add_command(delete_term)
 tell.add_command(load_terms)
 tell.add_command(export_terms)
 

pyegeria/commands/ops/gov_server_actions.py

@@ -104,9 +104,13 @@ def update_catalog_target(ctx, relationship_guid: str, catalog_target_name: str)
         print_exception_response(e)
 
 
+#
+#   This method will be updated based on forthcoming changes on the Egeria server side
+#
 @click.command("refresh")
+@click.option("-engine-host-guid", help="GUID of engine host to refresh.")
 @click.pass_context
-def refresh_gov_eng_config(ctx):
+def refresh_gov_eng_config(ctx, engine_host_guid: str):
     """Start or restart an engine-host from its known configuration"""
     c = ctx.obj
     p_client = EgeriaTech(c.view_server, c.view_server_url, c.userid, c.password)

pyegeria/commands/ops/monitor_integ_daemon_status.py

@@ -263,7 +263,7 @@ def main_live():
         view_url=view_url,
         user=userid,
         user_pass=user_pass,
-        paging=True,
+        paging=False,
     )
 
 

pyegeria/commands/ops/monitor_platform_status.py

@@ -64,11 +64,11 @@ def display_status(
             header_style="white on dark_blue",
             title_style="bold white on black",
             caption_style="white on black",
-            caption=f"Status of Platforms - '{url}'",
+            caption=f"Status of Platforms - '{view_url}'",
             show_lines=True,
             # expand=True
         )
-        table.add_column("Platform Name")
+        table.add_column("Platform Name & GUID")
         # table.add_column("Platform GUID")
         table.add_column("Platform URL")
         table.add_column("Platform Origin")
@@ -98,7 +98,7 @@ def display_status(
                 platform_url = platform_report.get("platformURLRoot", " ")
                 platform_origin = platform_report.get("platformOrigin", " ")
                 platform_started = platform_report.get("platformStartTime", " ")
-
+                platform_id = f"{platform_name}\n\n\t\t&\n\n{platform_guid}"
                 servers = platform_report.get("omagservers", None)
 
                 if servers is not None:
@@ -120,7 +120,7 @@ def display_status(
                         # server_list = server_list + serv
 
                     table.add_row(
-                        platform_name,
+                        platform_id,
                         platform_url,
                         platform_origin,
                         platform_desc,

pyegeria/commands/ops/monitor_server_status.py

@@ -70,12 +70,14 @@ def display_status(
             title_style="bold white on black",
             caption_style="white on black",
             caption=f"Server Status from Platform - '{url}'",
-            # show_lines=True,
+            show_lines=True,
         )
 
         table.add_column("Known Server")
         table.add_column("Status")
         if extended:
+            table.add_column("GUID", no_wrap=True)
+            table.add_column("Qualified Name")
             table.add_column("Description")
             table.add_column("Server Type")
             table.add_column("Last Started")
@@ -102,15 +104,31 @@ def display_status(
                 server_status = p_server.get("serverActiveStatus", "UNKNOWN")
                 if server_status in ("RUNNING", "STARTING"):
                     status = "Active"
-                elif server_status in ("INACTIVE", "STOPPING"):
+                elif server_status in ("INACTIVE", "STOPPING", "UNKNOWN"):
                     status = "Inactive"
                 else:
                     status = "UNKNOWN"
 
                 if extended:
+                    #
+                    #  get the qualified name and guid from get_server_by_name?
+                    #
+                    server_info = p_client.get_servers_by_name(server_name)
+                    if type(server_info) is str:
+                        guid = "---"
+                        qualified_name = "---"
+                    else:
+                        guid = ""
+                        qualified_name = ""
+                        for i in server_info:
+                            guid += f"{i["elementHeader"]["guid"]} "
+                            qualified_name += f"{i["properties"]["qualifiedName"]} "
+
                     table.add_row(
                         server_name,
                         "[red]Inactive" if status == "Inactive" else "[green]Active",
+                        guid,
+                        qualified_name,
                         server_desc,
                         server_type,
                         last_start_time,
@@ -144,7 +162,7 @@ def display_status(
 
 def main():
     parser = argparse.ArgumentParser()
-    parser.add_argument("--extended", help="Extended Information?")
+    parser.add_argument("--extended", default = True, help="Extended Information?")
     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")

pyegeria/commands/ops/refresh_integration_daemon.py

@@ -47,7 +47,7 @@ def refresh_connector(
         server = "integration-daemon" if server is None else server
 
         s_client.refresh_integration_connectors(
-            connector_name=connector, server_guid=None, server_name=server
+            connector_name=connector, server_guid=None, display_name=server
         )
 
         print(f"\n===> Integration Daemon '{server}' refreshed {statement}.")