pyegeria 5.3.5.3__py3-none-any.whl → 5.3.6.2__py3-none-any.whl

pyegeria/glossary_browser_omvs.py

@@ -10,12 +10,13 @@ added in subsequent versions of the glossary_omvs module.
 import asyncio
 from datetime import datetime
 
-from pyegeria import NO_GLOSSARIES_FOUND, NO_CATEGORIES_FOUND
-# import json
+from pyegeria import NO_GLOSSARIES_FOUND, NO_CATEGORIES_FOUND, NO_TERMS_FOUND
+import json
 from pyegeria._client import Client
 from pyegeria._validators import validate_guid, validate_name, validate_search_string
 from pyegeria.utils import body_slimmer
 from pyegeria._globals import NO_ELEMENTS_FOUND
+MD_SEPERATOR = "\n---\n\n"
 
 class GlossaryBrowser(Client):
     """
@@ -52,6 +53,79 @@ class GlossaryBrowser(Client):
 
         Client.__init__(self, view_server, platform_url, user_id, user_pwd, token)
 
+    def generate_glossaries_md(self, elements: list, search_string: str, form:bool = True)-> str:
+        if form:
+            elements_md = f"# Update Glossaries Form - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+            elements_action = "Update Glossary"
+        else:
+            elements_md = f"# Glossaries Report - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+            elements_action = None
+        search_string = search_string if search_string else "All Glossaries"
+        elements_md += f"Glossaries found from the search string:  `{search_string}`\n\n"
+
+        for element in elements:
+            guid = element['elementHeader'].get("guid", None)
+            properties = element['glossaryProperties']
+            display_name = properties.get("displayName", None)
+            description = properties.get("description", None)
+            language = properties.get("language", None)
+            usage = properties.get("usage", None)
+            qualified_name = properties.get("qualifiedName", None)
+
+            if form:
+                elements_md += f"# {elements_action}\n\n"
+                elements_md += f"## Glossary Name \n{display_name}\n\n"
+            else:
+                elements_md += f"# Glossary Name: {display_name}\n\n"
+
+
+            elements_md += f"## Description\n{description}\n\n"
+            elements_md += f"## Language\n{language}\n\n"
+            elements_md += f"## Usage\n{usage}\n\n"
+            elements_md += f"## Qualified Name\n{qualified_name}\n\n"
+            elements_md += f"## GUID\n{guid}\n\n"
+            elements_md += MD_SEPERATOR
+        return elements_md
+
+    def generate_terms_md(self, elements: list, search_string: str, form:bool = True)-> str:
+        if form:
+            elements_md = f"# Update terms Form - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+            elements_action = "Update Terms"
+        else:
+            elements_md = f"# Glossary Terms Report - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+            elements_action = None
+        search_string = search_string if search_string else "All Terms"
+        elements_md += f"Terms found from the search string:  `{search_string}`\n\n"
+
+        for element in elements:
+            guid = element['elementHeader'].get("guid", None)
+            element_properties = element['glossaryTermProperties']
+            display_name = element_properties.get("displayName", None)
+            summary = element_properties.get("summary", None)
+            description = element_properties.get("description", None)
+            examples = element_properties.get("examples", None)
+            usage = element_properties.get("usage", None)
+            pub_version = element_properties.get("publishedVersionIdentifier", None)
+            qualified_name = element_properties.get("qualifiedName", None)
+            status = element['elementHeader']['classifications'][0].get('status', None)
+
+            if form:
+                elements_md += f"# {elements_action}\n\n"
+                elements_md += f"## Term Name \n{display_name}\n\n"
+            else:
+                elements_md += f"# Term Name: {display_name}\n\n"
+
+            elements_md += f"## Status\n{status}\n\n"
+            elements_md += f"## Summary\n{summary}\n\n"
+            elements_md += f"## Description\n{description}\n\n"
+            elements_md += f"## Examples\n{examples}\n\n"
+            elements_md += f"## Usage\n{usage}\n\n"
+            elements_md += f"## Published Version\n{pub_version}\n\n"
+            elements_md += f"## Qualified Name\n{qualified_name}\n\n"
+            elements_md += f"## GUID\n{guid}\n\n"
+            elements_md += MD_SEPERATOR
+        return elements_md
+
     #
     #       Get Valid Values for Enumerations
     #
@@ -193,6 +267,8 @@ class GlossaryBrowser(Client):
         type_name: str = None,
         start_from: int = 0,
         page_size: int = None,
+        md: bool = False,
+        form: bool = True
     ) -> list | str:
         """Retrieve the list of glossary metadata elements that contain the search string. Async version.
             The search string is located in the request body and is interpreted as a plain string.
@@ -225,6 +301,12 @@ class GlossaryBrowser(Client):
         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.
+        md: bool, [default=False]
+            If true, a simplified markdown representation of the glossary will be returned
+        form: bool, [default=True]
+            If true and md is true, a form for the glossaries will be returned as a markdown string.
+            If false and md is true, a report for the glossaries will be returned.
+
         Returns
         -------
         List | str
@@ -263,7 +345,6 @@ class GlossaryBrowser(Client):
             "typeName": type_name,
         }
         body = body_slimmer(body)
-        # print(f"\n\nBody is: \n{body}")
 
         url = (
             f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-browser/glossaries/"
@@ -273,7 +354,12 @@ class GlossaryBrowser(Client):
         )
 
         response = await self._async_make_request("POST", url, body)
-        return response.json().get("elementList", "No Glossaries found")
+        glossary_elements = response.json().get("elementList", NO_GLOSSARIES_FOUND)
+        if glossary_elements == NO_GLOSSARIES_FOUND:
+            return NO_GLOSSARIES_FOUND
+        if md: # return a simplified markdown representation
+            return self.generate_glossaries_md(glossary_elements, search_string,form)
+        return response.json().get("elementList", NO_GLOSSARIES_FOUND)
 
     def find_glossaries(
         self,
@@ -287,6 +373,8 @@ class GlossaryBrowser(Client):
         type_name: str = None,
         start_from: int = 0,
         page_size: int = None,
+        md: bool = False,
+        form: bool = True
     ) -> list | str:
         """Retrieve the list of glossary metadata elements that contain the search string.
                 The search string is located in the request body and is interpreted as a plain string.
@@ -320,6 +408,11 @@ class GlossaryBrowser(Client):
          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.
+        md: bool, [default=False]
+            If true, a simplified markdown representation of the glossary will be returned
+        form: bool, [default=True]
+            If true and md is true, a form for the glossaries will be returned as a markdown string.
+            If false and md is true, a report for the glossaries will be returned.
         Returns
         -------
         List | str
@@ -350,6 +443,8 @@ class GlossaryBrowser(Client):
                 type_name,
                 start_from,
                 page_size,
+                md,
+                form
             )
         )
 
@@ -2162,6 +2257,8 @@ class GlossaryBrowser(Client):
         for_duplicate_processing: bool = False,
         start_from: int = 0,
         page_size: int = None,
+        md: bool = False,
+        form: bool = True,
     ) -> list | str:
         """Retrieve the list of glossary term metadata elements that contain the search string.
 
@@ -2193,6 +2290,11 @@ class GlossaryBrowser(Client):
             Page of results to start from
         page_size : int, optional
             Number of elements to return per page - if None, then default for class will be used.
+        md: bool, [default=False]
+            If true, a simplified markdown representation of the glossary will be returned
+        form: bool, [default=True]
+            If true and md is true, a form for the glossaries will be returned as a markdown string.
+            If false and md is true, a report for the glossaries will be returned.
 
         Returns
         -------
@@ -2238,7 +2340,7 @@ class GlossaryBrowser(Client):
             "effectiveTime": effective_time,
             "limitResultsByStatus": status_filter,
         }
-        # body = body_slimmer(body)
+        body = body_slimmer(body)
 
         url = (
             f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-browser/glossaries/"
@@ -2247,12 +2349,14 @@ class GlossaryBrowser(Client):
             f"forDuplicateProcessing={for_duplicate_processing_s}"
         )
 
-        # print(f"\n\nURL is: \n {url}\n\nBody is: \n{body}")
-
         response = await self._async_make_request("POST", url, body)
-        return response.json().get(
-            "elementList", "No terms found"
-        )  # return response.text
+        term_elements = response.json().get("elementList", NO_TERMS_FOUND)
+        if term_elements == NO_TERMS_FOUND:
+            return NO_TERMS_FOUND
+        if md:  # return a simplified markdown representation
+            return self.generate_terms_md(term_elements, search_string, form)
+        return response.json().get("elementList", NO_TERMS_FOUND)
+
 
     def find_glossary_terms(
         self,
@@ -2267,6 +2371,8 @@ class GlossaryBrowser(Client):
         for_duplicate_processing: bool = False,
         start_from: int = 0,
         page_size: int = None,
+        md: bool = False,
+        form: bool = True,
     ) -> list | str:
         """Retrieve the list of glossary term metadata elements that contain the search string.
 
@@ -2299,6 +2405,11 @@ class GlossaryBrowser(Client):
             Page of results to start from
         page_size : int, optional
             Number of elements to return per page - if None, then default for class will be used.
+        md: bool, [default=False]
+            If true, a simplified markdown representation of the glossary will be returned
+        form: bool, [default=True]
+            If true and md is true, a form for the glossaries will be returned as a markdown string.
+            If false and md is true, a report for the glossaries will be returned.
 
         Returns
         -------
@@ -2337,6 +2448,8 @@ class GlossaryBrowser(Client):
                 for_duplicate_processing,
                 start_from,
                 page_size,
+                md,
+                form,
             )
         )
 

pyegeria/glossary_manager_omvs.py

@@ -303,184 +303,6 @@ class GlossaryManager(GlossaryBrowser):
     #       Glossaries
     #
 
-    async def _async_find_glossaries(
-        self,
-        search_string: str,
-        effective_time: str = None,
-        starts_with: bool = False,
-        ends_with: bool = False,
-        ignore_case: bool = False,
-        for_lineage: bool = False,
-        for_duplicate_processing: bool = False,
-        type_name: str = None,
-        start_from: int = 0,
-        page_size: int = None,
-        output_format: str = "JSON",
-    ) -> list | str:
-        """Retrieve the list of glossary metadata elements that contain the search string. Async version.
-            The search string is located in the request body and is interpreted as a plain string.
-            The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
-
-        Parameters
-        ----------
-        search_string: str,
-            Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
-
-        effective_time: str, [default=None], optional
-            Effective time of the query. If not specified will default to any time. Time format is
-            "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-
-        starts_with : bool, [default=False], optional
-            Starts with the supplied string.
-        ends_with : bool, [default=False], optional
-            Ends with the supplied string
-        ignore_case : bool, [default=False], optional
-            Ignore case when searching
-        for_lineage : bool, [default=False], optional
-
-        for_duplicate_processing : bool, [default=False], optional
-        type_name: str, [default=None], optional
-            An optional parameter indicating the subtype of the glossary to filter by.
-            Values include 'ControlledGlossary', 'EditingGlossary', and 'StagingGlossary'
-        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.
-        output_format: str, [default="JSON"]
-            One of JSON or MD for now
-
-        Returns
-        -------
-        List | str
-
-        A list of glossary definitions active in the server.
-
-        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
-
-        """
-
-        if page_size is None:
-            page_size = self.page_size
-        starts_with_s = str(starts_with).lower()
-        ends_with_s = str(ends_with).lower()
-        ignore_case_s = str(ignore_case).lower()
-        for_lineage_s = str(for_lineage).lower()
-        for_duplicate_processing_s = str(for_duplicate_processing).lower()
-
-        validate_search_string(search_string)
-
-        if search_string == "*":
-            search_string = None
-
-        body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string,
-            "effectiveTime": effective_time,
-            "typeName": type_name,
-        }
-        body = body_slimmer(body)
-        # print(f"\n\nBody is: \n{body}")
-
-        url = (
-            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-browser/glossaries/"
-            f"by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
-            f"endsWith={ends_with_s}&ignoreCase={ignore_case_s}&forLineage={for_lineage_s}&"
-            f"forDuplicateProcessing={for_duplicate_processing_s}"
-        )
-
-        response = await self._async_make_request("POST", url, body)
-        if output_format == "JSON":
-            return response.json().get("elementList", "No Glossaries found")
-        elif output_format == "MD":
-            pass
-
-
-    def find_glossaries(
-        self,
-        search_string: str,
-        effective_time: str = None,
-        starts_with: bool = False,
-        ends_with: bool = False,
-        ignore_case: bool = False,
-        for_lineage: bool = False,
-        for_duplicate_processing: bool = False,
-        type_name: str = None,
-        start_from: int = 0,
-        page_size: int = None,
-    ) -> list | str:
-        """Retrieve the list of glossary metadata elements that contain the search string.
-                The search string is located in the request body and is interpreted as a plain string.
-                The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
-
-        Parameters
-        ----------
-        search_string: str,
-            Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
-
-        effective_time: str, [default=None], optional
-            Effective time of the query. If not specified will default to any time. Time format is
-            "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-
-        starts_with : bool, [default=False], optional
-            Starts with the supplied string.
-        ends_with : bool, [default=False], optional
-            Ends with the supplied string
-        ignore_case : bool, [default=False], optional
-            Ignore case when searching
-        for_lineage : bool, [default=False], optional
-             Indicates the search is for lineage.
-        for_duplicate_processing : bool, [default=False], optional
-        type_name: str, [default=None], optional
-            An optional parameter indicating the subtype of the glossary to filter by.
-            Values include 'ControlledGlossary', 'EditingGlossary', and 'StagingGlossary'
-         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
-
-        A list of glossary definitions active in the server.
-
-        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
-
-        """
-        loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(
-            self._async_find_glossaries(
-                search_string,
-                effective_time,
-                starts_with,
-                ends_with,
-                ignore_case,
-                for_lineage,
-                for_duplicate_processing,
-                type_name,
-                start_from,
-                page_size,
-            )
-        )
-
-        return response
 
     async def _async_get_glossaries_by_name(
         self,
@@ -3610,193 +3432,6 @@ class GlossaryManager(GlossaryBrowser):
 
         return response
 
-    async def _async_find_glossary_terms(
-        self,
-        search_string: str,
-        glossary_guid: str = None,
-        status_filter: list = [],
-        effective_time: str = None,
-        starts_with: bool = False,
-        ends_with: bool = False,
-        ignore_case: bool = True,
-        for_lineage: bool = False,
-        for_duplicate_processing: bool = False,
-        start_from: int = 0,
-        page_size: int = None,
-    ) -> list | str:
-        """Retrieve the list of glossary term metadata elements that contain the search string.
-
-        Parameters
-        ----------
-        search_string: str
-            Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
-        glossary_guid str
-            Identifier of the glossary to search within. If None, then all glossaries are searched.
-        status_filter: list, default = [], optional
-            Filters the results by the included Term statuses (such as 'ACTIVE', 'DRAFT'). If not specified,
-            the results will not be filtered.
-        effective_time: str, [default=None], optional
-            If specified, the term information will be retrieved if it is active at the `effective_time`.
-            Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-
-        starts_with : bool, [default=False], optional
-            Starts with the supplied string.
-        ends_with : bool, [default=False], optional
-            Ends with the supplied string
-        ignore_case : bool, [default=False], optional
-            Ignore case when searching
-        for_lineage : bool, [default=False], optional
-
-        for_duplicate_processing : bool, [default=False], optional
-
-        start_from: str, [default=0], optional
-            Page of results to start from
-        page_size : int, optional
-            Number of elements to return per page - if None, then default for class will be used.
-
-        Returns
-        -------
-        List | str
-
-        A list of term definitions
-
-        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
-        -----
-        The search string is located in the request body and is interpreted as a plain string.
-        The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
-        The request body also supports the specification of a glossaryGUID to restrict the search to within a single glossary.
-        """
-
-        if page_size is None:
-            page_size = self.page_size
-        if effective_time is None:
-            effective_time = datetime.now().isoformat()
-        starts_with_s = str(starts_with).lower()
-        ends_with_s = str(ends_with).lower()
-        ignore_case_s = str(ignore_case).lower()
-        for_lineage_s = str(for_lineage).lower()
-        for_duplicate_processing_s = str(for_duplicate_processing).lower()
-        if search_string == "*":
-            search_string = None
-
-        # validate_search_string(search_string)
-
-        body = {
-            "class": "GlossarySearchStringRequestBody",
-            "glossaryGUID": glossary_guid,
-            "searchString": search_string,
-            "effectiveTime": effective_time,
-            "limitResultsByStatus": status_filter,
-        }
-        body = body_slimmer(body)
-
-        url = (
-            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-browser/glossaries/"
-            f"terms/by-search-string?startFrom={start_from}&pageSize={page_size}&startsWith={starts_with_s}&"
-            f"endsWith={ends_with_s}&ignoreCase={ignore_case_s}&forLineage={for_lineage_s}&"
-            f"forDuplicateProcessing={for_duplicate_processing_s}"
-        )
-
-        # print(f"\n\nURL is: \n {url}\n\nBody is: \n{body}")
-
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get(
-            "elementList", NO_TERMS_FOUND
-        )  # return response.text
-
-    def find_glossary_terms(
-        self,
-        search_string: str,
-        glossary_guid: str = None,
-        status_filter: list = [],
-        effective_time: str = None,
-        starts_with: bool = False,
-        ends_with: bool = False,
-        ignore_case: bool = False,
-        for_lineage: bool = False,
-        for_duplicate_processing: bool = False,
-        start_from: int = 0,
-        page_size: int = None,
-    ) -> list | str:
-        """Retrieve the list of glossary term metadata elements that contain the search string.
-
-        Parameters
-        ----------
-        search_string: str
-            Search string to use to find matching glossaries. If the search string is '*' then all glossaries returned.
-        glossary_guid str
-            Identifier of the glossary to search within. If None, then all glossaries are searched.
-        status_filter: list, default = [], optional
-            Filters the results by the included Term statuses (such as 'ACTIVE', 'DRAFT'). If not specified,
-            the results will not be filtered.
-        effective_time: str, [default=None], optional
-            If specified, the term information will be retrieved if it is active at the `effective_time`.
-            Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-
-        starts_with : bool, [default=False], optional
-            Starts with the supplied string.
-        ends_with : bool, [default=False], optional
-            Ends with the supplied string
-        ignore_case : bool, [default=False], optional
-            Ignore case when searching
-        for_lineage : bool, [default=False], optional
-
-        for_duplicate_processing : bool, [default=False], optional
-
-        start_from: str, [default=0], optional
-            Page of results to start from
-        page_size : int, optional
-            Number of elements to return per page - if None, then default for class will be used.
-
-        Returns
-        -------
-        List | str
-
-        A list of term definitions
-
-        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
-        -----
-        The search string is located in the request body and is interpreted as a plain string.
-        The request parameters, startsWith, endsWith and ignoreCase can be used to allow a fuzzy search.
-        The request body also supports the specification of a glossaryGUID to restrict the search to within a single glossary.
-        """
-
-        loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(
-            self._async_find_glossary_terms(
-                search_string,
-                glossary_guid,
-                status_filter,
-                effective_time,
-                starts_with,
-                ends_with,
-                ignore_case,
-                for_lineage,
-                for_duplicate_processing,
-                start_from,
-                page_size,
-            )
-        )
-
-        return response
 
 
 if __name__ == "__main__":

{pyegeria-5.3.5.3.dist-info → pyegeria-5.3.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyegeria
-Version: 5.3.5.3
+Version: 5.3.6.2
 Summary: A python client for Egeria
 License: Apache 2.0
 Keywords: egeria,metadata,governance