pyegeria 1.5.1.0.18__py3-none-any.whl → 1.5.1.0.21__py3-none-any.whl

commands/tech/list_tech_templates.py

@@ -1,4 +1,6 @@
 """This creates a templates guid file from the core metadata archive"""
+import json
+
 from rich.markdown import Markdown
 from rich.prompt import Prompt
 import os
@@ -16,30 +18,66 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    RegisteredInfo
+    RegisteredInfo,
 )
 
 
 console = Console()
 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_templates_spec(search_string:str, server: str,
-                       url: str, username: str, password: str, jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH
+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 list_templates(
+    search_string: str, server: str, url: str, username: str, password: str
+) -> []:
+    """Return a list of templates for one or more technology type"""
+    a_client = AutomatedCuration(server, url, username)
+    token = a_client.create_egeria_bearer_token(username, password)
+    tech_list = a_client.find_technology_types(search_string, page_size=0)
+    tech_info_list: dict = []
+
+    if type(tech_list) is list:
+        entry = {}
+        for item in tech_list:
+            if "deployedImplementationType" not in item["qualifiedName"]:
+                continue
+
+            details = a_client.get_technology_type_detail(item["name"])
+            entry = {details["name"]: {}}
+            if type(details) is str:
+                tech_info_list.append(entry)
+                continue
+            templates = details.get("catalogTemplates", "Not Found")
+            if type(templates) is list:
+                t_list = []
+                entry = {details["name"]: {}}
+                for template in templates:
+                    t_list.append({"template": template["name"]})
+                entry[details["name"]] = t_list
+                print(json.dumps(entry, indent=2))
+
+
+def display_templates_spec(
+    search_string: str,
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
 ):
-
     a_client = AutomatedCuration(server, url, username)
     token = a_client.create_egeria_bearer_token(username, password)
     tech_list = a_client.find_technology_types(search_string, page_size=0)
@@ -62,21 +100,19 @@ def display_templates_spec(search_string:str, server: str,
 
         table.add_column("Name", width=20)
         table.add_column("Template Name", width=20)
-        table.add_column("Template GUID", width = 38,no_wrap=True)
+        table.add_column("Template GUID", width=38, no_wrap=True)
         table.add_column("Placeholders")
 
-
         if type(tech_list) is list:
             for item in tech_list:
-                if 'deployedImplementationType' not in item['qualifiedName']:
+                if "deployedImplementationType" not in item["qualifiedName"]:
                     continue
                 placeholder_table = Table(expand=False, show_lines=True)
-                placeholder_table.add_column("Name", width = 20,no_wrap=True)
-                placeholder_table.add_column("Type", width = 10)
-                placeholder_table.add_column("Required", width = 10)
-                placeholder_table.add_column("Example", width = 20)
-                placeholder_table.add_column("Description", width = 40)
-
+                placeholder_table.add_column("Name", width=20, no_wrap=True)
+                placeholder_table.add_column("Type", width=10)
+                placeholder_table.add_column("Required", width=10)
+                placeholder_table.add_column("Example", width=20)
+                placeholder_table.add_column("Description", width=40)
 
                 name = item.get("name", "none")
 
@@ -90,7 +126,11 @@ def display_templates_spec(search_string:str, server: str,
                     for template in templates:
                         template_name = template.get("name", None)
 
-                        template_name = f"{name}_Template" if template_name is None else template_name
+                        template_name = (
+                            f"{name}_Template"
+                            if template_name is None
+                            else template_name
+                        )
 
                         specification = template["specification"]["placeholderProperty"]
                         template_guid = template["relatedElement"]["guid"]
@@ -101,10 +141,17 @@ def display_templates_spec(search_string:str, server: str,
                             placeholder_name = placeholder["placeholderPropertyName"]
                             placeholder_required = placeholder["required"]
                             placeholder_example = placeholder.get("example", None)
-                            placeholder_table.add_row(placeholder_name, placeholder_data_type,  placeholder_required,
-                                                      placeholder_example, placeholder_description,)
-
-                        table.add_row(name, template_name, template_guid, placeholder_table)
+                            placeholder_table.add_row(
+                                placeholder_name,
+                                placeholder_data_type,
+                                placeholder_required,
+                                placeholder_example,
+                                placeholder_description,
+                            )
+
+                        table.add_row(
+                            name, template_name, template_guid, placeholder_table
+                        )
 
             return table
         else:
@@ -117,7 +164,11 @@ def display_templates_spec(search_string:str, server: str,
         with console.pager(styles=True):
             console.print(generate_table())
 
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
     finally:
@@ -140,14 +191,14 @@ def main():
     guid = None
 
     try:
-        search_string = Prompt.ask("Enter the technology you are searching for:", default="*")
+        search_string = Prompt.ask(
+            "Enter the technology you are searching for:", default="*"
+        )
         display_templates_spec(search_string, server, url, userid, password)
-    except(KeyboardInterrupt):
+        # list_templates(search_string, server, url, userid, password)
+    except KeyboardInterrupt:
         pass
 
 
 if __name__ == "__main__":
     main()
-
-
-

pyegeria/automated_curation_omvs.py

@@ -2430,21 +2430,33 @@ class AutomatedCuration(Client):
     #   Initiate surveys
     #
 
-    async def _async_initiate_postgres_database_survey(
-        self, postgres_database_guid: str
-    ) -> str:
-        """Initiate a postgres database survey"""
+    async def _async_initiate_survey(self, survey_name: str, resource_guid: str) -> str:
+        """Initiate a survey of the survey_name on the target resource. Async Version.
+
+        Parameters
+        ----------
+        survey_name: str
+            The name of the survey to initiate.
+        resource_guid : str
+            The GUID of the resource to be surveyed.
+
+        Returns
+        -------
+        str
+            The GUID of the initiated action or "Action not initiated" if the action was not initiated.
+
+        """
 
         url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "PostgreSQLSurveys:survey-postgres-database",
+            "governanceActionTypeQualifiedName": survey_name,
             "actionTargets": [
                 {
                     "class": "NewActionTarget",
-                    "actionTargetName": "postgresDatabase",
-                    "actionTargetGUID": postgres_database_guid,
+                    "actionTargetName": "serverToSurvey",
+                    "actionTargetGUID": resource_guid,
                 }
             ],
         }
@@ -2455,92 +2467,22 @@ class AutomatedCuration(Client):
         """Initiate a postgres database survey"""
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_postgres_database_survey(postgres_database_guid)
+            self._async_initiate_survey(
+                "PostgreSQLSurveys:survey-postgres-database", postgres_database_guid
+            )
         )
         return response
 
-    async def _async_initiate_postgres_server_survey(
-        self, postgres_server_guid: str
-    ) -> str:
-        """Initiate a postgres server survey - Async version"""
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "PostgreSQLSurveys:survey-postgres-server",
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "serverToSurvey",
-                    "actionTargetGUID": postgres_server_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_postgres_server_survey(self, postgres_server_guid: str) -> str:
         """Initiate a postgres server survey"""
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_postgres_server_survey(postgres_server_guid)
+            self._async_initiate_survey(
+                "PostgreSQLSurveys:survey-postgres-server", postgres_server_guid
+            )
         )
         return response
 
-    async def _async_initiate_file_folder_survey(
-        self,
-        file_folder_guid: str,
-        survey_name: str = "FileSurveys:survey-folder",
-    ) -> str:
-        """Initiate a file folder survey - async version
-
-        Parameters:
-        ----------
-            file_folder_guid: str
-                The GUID of the File Folder that we wish to survey.
-            survey_name: str, optional
-                The unique name of the survey routine to execute. Default surveys all folders.
-
-        Returns:
-        -------
-            str:
-                The guid of the survey being run.
-
-        Raises:
-        ------
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-                                       this exception is raised with details from the response content.
-            PropertyServerException: If the API response indicates a server side error.
-            UserNotAuthorizedException:
-
-        Notes:
-            There are multiple kinds of file folder surveys available, each with their own purpose. They are described
-            in the Core Content Brain.
-
-            File Folder Survey Names currently include::
-            - AssetSurvey:survey-folders
-            - AssetSurvey:survey-folder-and-files
-            - AssetSurvey:survey-all-folders
-            - AssetSurvey:survey-all-folders-and-files
-        """
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": survey_name,
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "folderToSurvey",
-                    "actionTargetGUID": file_folder_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_file_folder_survey(
         self,
         file_folder_guid: str,
@@ -2581,65 +2523,21 @@ class AutomatedCuration(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_file_folder_survey(file_folder_guid, survey_name)
+            self._async_initiate_survey(
+                survey_name,
+                file_folder_guid,
+            )
         )
         return response
 
-    async def _async_initiate_file_survey(self, file_guid: str) -> str:
-        """Initiate a file survey - async version"""
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "FileSurveys:survey-data-file",
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "fileToSurvey",
-                    "actionTargetGUID": file_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_file_survey(self, file_guid: str) -> str:
         """Initiate a file survey"""
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_initiate_file_survey(file_guid))
+        response = loop.run_until_complete(
+            self._async_initiate_survey("FileSurveys:survey-data-file", file_guid)
+        )
         return response
 
-    async def _async_initiate_kafka_server_survey(self, kafka_server_guid: str) -> str:
-        """Initiate survey of a kafka server. Async Version.
-        Parameters
-        ----------
-        kafka_server_guid : str
-            The GUID of the Kafka server to be surveyed.
-
-        Returns
-        -------
-        str
-            The GUID of the initiated action or "Action not initiated" if the action was not initiated.
-
-        """
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "ApacheKafkaSurveys:survey-kafka-server",
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "serverToSurvey",
-                    "actionTargetGUID": kafka_server_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_kafka_server_survey(self, kafka_server_guid: str) -> str:
         """Initiate survey of a kafka server.
         Parameters
@@ -2656,41 +2554,12 @@ class AutomatedCuration(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_kafka_server_survey(kafka_server_guid)
+            self._async_initiate_survey(
+                "ApacheKafkaSurveys:survey-kafka-server", kafka_server_guid
+            )
         )
         return response
 
-    async def _async_initiate_uc_server_survey(self, uc_server_guid: str) -> str:
-        """Initiate survey of a Unity Catalog server. Async Version.
-        Parameters
-        ----------
-        uc_server_guid : str
-            The GUID of the Kafka server to be surveyed.
-
-
-        Returns
-        -------
-        str
-            The GUID of the initiated action or "Action not initiated" if the action was not initiated.
-
-        """
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "UnityCatalogSurveys:survey-unity-catalog-server",
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "serverToSurvey",
-                    "actionTargetGUID": uc_server_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_uc_server_survey(self, uc_server_guid: str) -> str:
         """Initiate survey of a Unity Catalog server. Async Version.
         Parameters
@@ -2707,40 +2576,12 @@ class AutomatedCuration(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_uc_server_survey(uc_server_guid)
+            self._async_initiate_survey(
+                "UnityCatalogSurveys:survey-unity-catalog-server", uc_server_guid
+            )
         )
         return response
 
-    async def _async_initiate_uc_schema_survey(self, uc_schema_guid: str) -> str:
-        """Initiate survey of a Unity Catalog schema. Async Version.
-        Parameters
-        ----------
-        uc_schema_guid : str
-            The GUID of the Kafka server to be surveyed.
-
-        Returns
-        -------
-        str
-            The GUID of the initiated action or "Action not initiated" if the action was not initiated.
-
-        """
-
-        url = f"{self.curation_command_root}/governance-action-types/initiate"
-
-        body = {
-            "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "UnityCatalogSurveys:survey-unity-catalog-schema",
-            "actionTargets": [
-                {
-                    "class": "NewActionTarget",
-                    "actionTargetName": "serverToSurvey",
-                    "actionTargetGUID": uc_schema_guid,
-                }
-            ],
-        }
-        response = await self._async_make_request("POST", url, body)
-        return response.json().get("guid", "Action not initiated")
-
     def initiate_uc_schema_survey(self, uc_schema_guid: str) -> str:
         """Initiate survey of a Unity Catalog schema. Async Version.
         Parameters
@@ -2758,7 +2599,9 @@ class AutomatedCuration(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_initiate_uc_schema_survey(uc_schema_guid)
+            self._async_initiate_survey(
+                "UnityCatalogSurveys:survey-unity-catalog-schema", uc_schema_guid
+            )
         )
         return response
 

pyegeria/runtime_manager_omvs.py

@@ -59,7 +59,7 @@ class RuntimeManager(Client):
         )
 
     async def __async__get_guid__(
-        self, guid: str = None, name: str = None, property_name: str = "name"
+        self, guid: str = None, name: str = None, property_name: str = "qualifiedName"
     ) -> 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
@@ -92,7 +92,7 @@ class RuntimeManager(Client):
             )
 
     def __get_guid__(
-        self, guid: str = None, name: str = None, property_name: str = "name"
+        self, guid: str = None, name: str = None, property_name: str = "qualifiedName"
     ) -> 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
@@ -1128,6 +1128,7 @@ class RuntimeManager(Client):
         UserNotAuthorizedException
 
         """
+        server_name = f"Metadata Access Server:{server_name}"
         server_guid = self.__get_guid__(server_guid, server_name)
         url = f"{self.runtime_command_root}/metadata-access-stores/{server_guid}/instance/load/open-metadata-archives/file"