pyegeria 1.5.1.1.37__tar.gz → 1.5.1.1.38__tar.gz

{pyegeria-1.5.1.1.37 → pyegeria-1.5.1.1.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 1.5.1.1.37
+Version: 1.5.1.1.38
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

{pyegeria-1.5.1.1.37 → pyegeria-1.5.1.1.38}/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-1.5.1.1.37 → pyegeria-1.5.1.1.38}/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-1.5.1.1.37 → pyegeria-1.5.1.1.38}/pyegeria/commands/cat/list_servers_deployed_imp.py

@@ -81,10 +81,14 @@ def display_servers_by_dep_imp(
         table.add_column("Description")
         table.add_column("Qualified Name & GUID", no_wrap=True)
 
-        server_list = p_client.get_servers_by_dep_impl_type(filter)
-        if type(server_list) is str:
+        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", "---")
@@ -144,7 +148,9 @@ def main():
     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("Search string", default="*")
+    filter = Prompt.ask(
+        "Filter deployed for deployed implementation type by search string", default="*"
+    )
     display_servers_by_dep_imp(filter, server, url, userid, user_pass)
 
 

{pyegeria-1.5.1.1.37 → pyegeria-1.5.1.1.38}/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-1.5.1.1.37 → pyegeria-1.5.1.1.38}/pyegeria/commands/cli/egeria.py

@@ -43,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
@@ -936,7 +937,9 @@ def archives(ctx):
 
 @show.command("deployed-servers")
 @click.option(
-    "--search-string", default="*", help="Filter deployed servers by search string"
+    "--search-string",
+    default="*",
+    help="Filter deployed for deployed implementation type by search string",
 )
 @click.pass_context
 def show_deployed_servers(ctx, search_string):
@@ -1035,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-1.5.1.1.37 → pyegeria-1.5.1.1.38}/pyegeria/commands/cli/egeria_cat.py

@@ -22,6 +22,7 @@ from pyegeria.commands.cat.glossary_actions import (
     create_glossary,
     delete_glossary,
     create_term,
+    delete_term,
     load_terms,
     export_terms,
 )
@@ -519,7 +520,9 @@ def list_archives(ctx):
 
 @show.command("deployed-servers")
 @click.option(
-    "--search-string", default="*", help="Filter deployed servers by search string"
+    "--search-string",
+    default="*",
+    help="Filter deployed for deployed implementation type by search string",
 )
 @click.pass_context
 def show_deployed_servers(ctx, search_string):
@@ -615,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-1.5.1.1.37 → pyegeria-1.5.1.1.38}/pyegeria/glossary_manager_omvs.py

@@ -2308,6 +2308,119 @@ class GlossaryManager(GlossaryBrowser):
 
         return
 
+    async def _async_update_term(
+        self,
+        glossary_term_guid: str,
+        body: dict,
+        is_merge_update: bool,
+    ) -> None:
+        """Add the data field values classification to a glossary term
+
+            Async Version.
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+            body: dict
+                Body containing information about the data field to add
+            is_merge_update: bool
+                Whether the data field values should be merged with existing definition or replace it.
+
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         PropertyServerException
+             Raised by the server when an issue arises in processing a valid request.
+         NotAuthorizedException
+             The principle specified by the user_id does not have authorization for the requested action.
+        Notes
+        -----
+        An example body is:
+
+        {
+            "class" : "ReferenceableRequestBody",
+            "elementProperties" :
+                {
+                    "class" : "GlossaryTermProperties",
+                    "description" : "This is the long description of the term. And this is some more text."
+                },
+                "updateDescription" : "Final updates based on in-house review comments."
+        }
+
+        """
+
+        validate_guid(glossary_term_guid)
+        is_merge_update_s = str(is_merge_update).lower()
+
+        url = (
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/terms/{glossary_term_guid}/"
+            f"update?isMergeUpdate={is_merge_update_s}"
+        )
+
+        await self._async_make_request("POST", url, body)
+        return
+
+    def update_term(
+        self,
+        glossary_term_guid: str,
+        body: dict,
+        is_merge_update: bool,
+    ) -> None:
+        """Add the data field values classification to a glossary term
+
+            Async Version.
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+            body: dict
+                Body containing information about the data field to add
+            is_merge_update: bool
+                Whether the data field values should be merged with existing definition or replace it.
+
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         PropertyServerException
+             Raised by the server when an issue arises in processing a valid request.
+         NotAuthorizedException
+             The principle specified by the user_id does not have authorization for the requested action.
+        Notes
+        -----
+        An example body is:
+
+        {
+            "class" : "ReferenceableRequestBody",
+            "elementProperties" :
+                {
+                    "class" : "GlossaryTermProperties",
+                    "description" : "This is the long description of the term. And this is some more text."
+                },
+                "updateDescription" : "Final updates based on in-house review comments."
+        }
+
+        """
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_update_term(glossary_term_guid, body, is_merge_update)
+        )
+
+        return
+
     async def _async_update_term_version_id(
         self,
         glossary_term_guid: str,
@@ -2512,30 +2625,26 @@ class GlossaryManager(GlossaryBrowser):
 
         return response
 
-    async def _async_get_terms_for_glossary(
+    async def _async_delete_term(
         self,
-        glossary_guid: str,
-        effective_time: str = None,
-        start_from: int = 0,
-        page_size: int = None,
+        term_guid: str,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
     ) -> list | str:
-        """Retrieve the list of glossary terms associated with a glossary.
-            The request body also supports the specification of an effective time for the query.
+        """Delete the glossary terms associated with the specified glossary. Async version.
+
         Parameters
         ----------
-            glossary_guid : str
-                Unique identifier for the glossary
-            effective_time : str, optional
-                If specified, terms are potentially included if they are active at the`effective_time.
-                Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)`
-            start_from: int, optional defaults to 0
-                The page number to start retrieving elements from
-            page_size : int, optional defaults to None
-                The number of elements to retrieve
+            term_guid : str,
+                The unique identifier for the term to delete.
+            for_lineage: bool, opt, default = False
+                Set true for lineage processing - generally false.
+            for_duplicate_processing: bool, opt, default = False
+                Set true if duplicate processing handled externally - generally set False.
+
         Returns
         -------
-        dict
-            The glossary definition associated with the glossary_guid
+        None
 
         Raises
         ------
@@ -2549,48 +2658,36 @@ class GlossaryManager(GlossaryBrowser):
         -----
         """
 
-        validate_guid(glossary_guid)
-
-        if page_size is None:
-            page_size = self.page_size
+        validate_guid(term_guid)
 
         url = (
-            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-browser/glossaries/"
-            f"{glossary_guid}/terms/retrieve?startFrom={start_from}&pageSize={page_size}"
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/glossaries/"
+            f"terms/{term_guid}/remove?forLineage={for_lineage}&forDuplicateProcessing={for_duplicate_processing}"
         )
 
-        if effective_time is not None:
-            body = {"effectiveTime": effective_time}
-            response = await self._async_make_request("POST", url, body)
-        else:
-            response = await self._async_make_request("POST", url)
-
-        return response.json().get("elementList", "No terms found")
+        await self._async_make_request("POST", url)
+        return
 
-    def get_terms_for_glossary(
+    def delete_term(
         self,
-        glossary_guid: str,
-        effective_time: str = None,
-        start_from: int = 0,
-        page_size: int = None,
+        term_guid: str,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
     ) -> list | str:
-        """Retrieve the list of glossary terms associated with a glossary.
-            The request body also supports the specification of an effective time for the query.
+        """Delete the glossary terms associated with the specified glossary.
+
         Parameters
         ----------
-            glossary_guid : str
-                Unique identifier for the glossary
-            effective_time : str, optional
-                If specified, terms are potentially returned if they are active at the `effective_time`
-                Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-            start_from: int, optional defaults to 0
-                The page number to start retrieving elements from
-            page_size : int, optional defaults to None
-                The number of elements to retrieve
+            term_guid : str,
+                The unique identifier for the term to delete.
+            for_lineage: bool, opt, default = False
+                Set true for lineage processing - generally false.
+            for_duplicate_processing: bool, opt, default = False
+                Set true if duplicate processing handled externally - generally set False.
+
         Returns
         -------
-        dict
-            The glossary definition associated with the glossary_guid
+        None
 
         Raises
         ------
@@ -2604,13 +2701,11 @@ class GlossaryManager(GlossaryBrowser):
         -----
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(
-            self._async_get_terms_for_glossary(
-                glossary_guid, effective_time, start_from, page_size
-            )
+        loop.run_until_complete(
+            self._async_delete_term(term_guid, for_lineage, for_duplicate_processing)
         )
 
-        return response
+        return
 
     async def _async_get_term_relationships(
         self,

{pyegeria-1.5.1.1.37 → pyegeria-1.5.1.1.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "1.5.1.1.37"
+version = "1.5.1.1.38"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"