pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/create_tech_guid_lists.py

@@ -0,0 +1,105 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Script to create a new file to initiate tech guids.
+These GUIDS should be copied into the pyegeria/__init__.py.
+
+"""
+from datetime import datetime
+
+from rich.console import Console
+
+from pyegeria import AutomatedCuration, ServerOps
+
+console = Console(width=200)
+
+
+def build_global_guid_lists(
+    server: str = "view-server",
+    url: str = "https://localhost:9443",
+    user_id: str = "erinoverview",
+    user_pwd: str = "secret",
+) -> None:
+    """This is a utility function that builds arrays of guid lists for Templates & Connectors"""
+
+    cur_time = datetime.now().strftime("%d-%m-%Y %H:%M")
+    file_name = f"./tech_guids_{cur_time}.py"
+    a_client = AutomatedCuration(server, url, user_id=user_id, user_pwd=user_pwd)
+    token = a_client.create_egeria_bearer_token()
+    # get all technology types
+
+    tech_types = a_client.get_all_technology_types()
+    if type(tech_types) is list:
+        with open(file_name, "w") as f:
+            out = f"global template_guids, integration_guids\n"
+            f.write(out)
+            for tech_type in tech_types:
+                # get tech type details
+                display_name = tech_type["name"]
+
+                details = a_client.get_technology_type_detail(display_name)
+                if type(details) is str:
+                    console.print(f"{display_name} technology type has no details")
+                    continue
+                # get templates and update the template_guids global
+                templates = details.get("catalogTemplates", "Not Found")
+
+                if type(templates) is list:
+                    for template in templates:
+                        template_name = template.get("name", None).replace(
+                            " template", ""
+                        )
+                        template_guid = template["relatedElement"]["guid"]
+                        out = f"TEMPLATE_GUIDS['{template_name}'] = '{template_guid}'\n"
+                        console.print(
+                            f"Added {template_name} template with GUID {template_guid}"
+                        )
+                        f.write(out)
+                else:
+                    console.print(f"{display_name} technology type has no templates")
+                # Now find the integration connector guids
+                resource_list = details.get("resourceList", " ")
+                if type(resource_list) is list:
+                    for resource in resource_list:
+                        resource_guid = resource["relatedElement"]["guid"]
+                        resource_type = resource["relatedElement"]["type"]["typeName"]
+                        if resource_type == "IntegrationConnector":
+                            if resource["resourceUse"] == "Catalog Resource":
+                                int_con = resource["relatedElement"]["uniqueName"]
+                                int_con_name = int_con.split(":")[-1].replace(
+                                    "IntegrationConnector", ""
+                                )
+
+                                out = f"INTEGRATION_GUIDS['{int_con_name}'] = '{resource_guid}'\n"
+                                console.print(
+                                    f"Added {int_con_name} integration connector with GUID {resource_guid}"
+                                )
+                                f.write(out)
+                else:
+                    console.print(
+                        f"{display_name} technology type has no integration connectors"
+                    )
+            #
+            #   Ok - now lets harvest integration connectors using get_integration_daemon_status from ServerOps
+            #   Assume that integration daemon called integration_daemon
+            #
+            s_client = ServerOps(
+                "integration_daemon", url, user_id=user_id, user_pwd=user_pwd
+            )
+            integ_status = s_client.get_integration_daemon_status()
+
+            if type(integ_status) is dict:
+                connections = integ_status["integrationConnectorReports"]
+                for connection in connections:
+                    int_con_name = connection["connectorName"]
+                    resource_guid = connection["connectorGUID"]
+                    out = f"INTEGRATION_GUIDS['{int_con_name}'] = '{resource_guid}'\n"
+                    console.print(
+                        f"Added {int_con_name} integration connector with GUID {resource_guid}"
+                    )
+                    f.write(out)
+
+
+if __name__ == "__main__":
+    build_global_guid_lists()

pyegeria/egeria_cat_client.py

@@ -0,0 +1,78 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+This class is meant to be a client for catalog users and currently inherits from
+AssetCatalog, CollectionManager, GlossaryManager, and ProjectManager.
+
+"""
+
+from pyegeria import (
+    AssetCatalog,
+    CollectionManager,
+    EgeriaMy,
+    GlossaryManager,
+    ProjectManager,
+)
+
+
+class EgeriaCat(
+    AssetCatalog,
+    CollectionManager,
+    EgeriaMy,
+    GlossaryManager,
+    # GovernanceAuthor,
+    # PeopleOrganizer,
+    ProjectManager,
+):
+    """
+    Client to issue Runtime status requests.
+
+    Attributes:
+
+        server_name: str
+                Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        token: str
+            An optional bearer token
+
+    Methods:
+
+    """
+
+    def __init__(
+        self,
+        view_server: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
+        token: str = None,
+    ):
+        self.view_server = view_server
+        self.platform_url = platform_url
+        self.user_id = user_id
+        self.user_pwd = user_pwd
+
+        AssetCatalog.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        CollectionManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        EgeriaMy.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+
+        GlossaryManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+        ProjectManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+
+if __name__ == "__main__":
+    print("Egeria Cat Client")

pyegeria/egeria_client.py

@@ -0,0 +1,117 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+This class is the overall Egeria Client covering all of the functional pyegeria classes. May not be appropriate
+for all use cases..using the more role based clients is often appropriate:
+    * EgeriaCat - for catalog users
+    * EgeriaConfig - for configuring the Egeria platform and servers
+    * EgeriaMy - for personal actions
+    * EgeriaOps - for operations and administration
+    * EgeriaTech - for technical users such as data scientists and engineers
+
+"""
+
+from pyegeria import (
+    AssetCatalog,
+    CollectionManager,
+    EgeriaCat,
+    EgeriaMy,
+    GlossaryManager,
+    ProjectManager,
+    RuntimeManager,
+    ServerOps,
+    ActionAuthor,
+    AutomatedCuration,
+    ClassificationManager,
+    RegisteredInfo,
+    ValidMetadataManager,
+    FullServerConfig,
+    EgeriaConfig,
+    MetadataExplorer,
+)
+
+
+class Egeria(
+    AssetCatalog,
+    CollectionManager,
+    EgeriaMy,
+    GlossaryManager,
+    # GovernanceAuthor,
+    # PeopleOrganizer,
+    ProjectManager,
+    RuntimeManager,
+    ServerOps,
+    FullServerConfig,
+    ActionAuthor,
+    AutomatedCuration,
+    ClassificationManager,
+    RegisteredInfo,
+    # TemplateManager,
+    ValidMetadataManager,
+    MetadataExplorer,
+):
+    """
+    Client to issue Runtime status requests.
+
+    Attributes:
+
+        view_server: str
+                Name of the view server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        token: str
+            An optional bearer token
+
+    Methods:
+
+    """
+
+    def __init__(
+        self,
+        view_server: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
+        token: str = None,
+    ):
+        AssetCatalog.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        CollectionManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+        EgeriaMy.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+
+        GlossaryManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+        ProjectManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+        RuntimeManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token=token
+        )
+        ServerOps.__init__(self, view_server, platform_url, user_id, user_pwd)
+
+        EgeriaConfig.__init__(self, view_server, platform_url, user_id, user_pwd)
+
+        ActionAuthor.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        AutomatedCuration.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        ClassificationManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        RegisteredInfo.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        ValidMetadataManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )

pyegeria/egeria_config_client.py

@@ -0,0 +1,45 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Client to configure the Egeria platform and servers
+
+"""
+
+from pyegeria import FullServerConfig, ServerOps
+
+
+class EgeriaConfig(FullServerConfig, ServerOps):
+    """
+    Client for configuring the Egeria Platform and Servers
+
+    Attributes:
+
+        server_name: str
+                Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+
+    Methods:
+        Inherits methods from FullServerConfig
+    """
+
+    def __init__(
+        self, server_name: str, platform_url: str, user_id: str, user_pwd: str = None
+    ):
+        self.server_name = server_name
+        self.platform_url = platform_url
+        self.user_id = user_id
+        self.user_pwd = user_pwd
+
+        FullServerConfig.__init__(self, server_name, platform_url, user_id, user_pwd)
+        ServerOps.__init__(self, server_name, platform_url, user_id, user_pwd)
+
+
+if __name__ == "__main__":
+    print("Main-Config Client")

pyegeria/egeria_my_client.py

@@ -0,0 +1,56 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Runtime manager is a view service that supports user interaction with the running platforms.
+
+"""
+
+from pyegeria._exceptions import (
+    InvalidParameterException,
+)
+from pyegeria import max_paging_size, body_slimmer, MyProfile, FeedbackManager
+
+
+class EgeriaMy(MyProfile, FeedbackManager):
+    """
+    Client to issue Runtime status requests.
+
+    Attributes:
+
+        view_server: str
+                Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+
+
+    Methods:
+        Inherits from MyProfile, FeedbackManager
+    """
+
+    def __init__(
+        self,
+        view_server: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
+        token: str = None,
+    ):
+        self.view_server = view_server
+        self.platform_url = platform_url
+        self.user_id = user_id
+        self.user_pwd = user_pwd
+
+        MyProfile.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        FeedbackManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+
+if __name__ == "__main__":
+    print("Main-Egeria My Client")

pyegeria/egeria_tech_client.py

@@ -0,0 +1,93 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Runtime manager is a view service that supports user interaction with the running platforms.
+
+"""
+
+from pyegeria._exceptions import (
+    InvalidParameterException,
+)
+from pyegeria import (
+    max_paging_size,
+    body_slimmer,
+    MyProfile,
+    FeedbackManager,
+    EgeriaCat,
+    ValidMetadataManager,
+    AutomatedCuration,
+    # ActionAuthor,
+    ClassificationManager,
+    RegisteredInfo,
+    RuntimeManager,
+    TEMPLATE_GUIDS,
+    INTEGRATION_GUIDS,
+    MetadataExplorer,
+)
+
+
+class EgeriaTech(
+    # ActionAuthor,
+    AutomatedCuration,
+    EgeriaCat,
+    ClassificationManager,
+    RegisteredInfo,
+    RuntimeManager,
+    ValidMetadataManager,
+    MetadataExplorer,
+):
+    """
+    Client for technical Egeria users.
+
+    Attributes:
+
+        view_server: str
+                Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        token: str, optional
+            Bearer token
+
+    Methods:
+        Inherits methods from EgeriaCat, ActionAuthor, AutomatedCuration,
+        ClassificationManager, RegisteredInfo, ValidMetadataManager
+    """
+
+    def __init__(
+        self,
+        view_server: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
+        token: str = None,
+    ):
+        # ActionAuthor.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        AutomatedCuration.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        EgeriaCat.__init__(self, view_server, platform_url, user_id, user_pwd, token)
+        ClassificationManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        RegisteredInfo.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        RuntimeManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        ValidMetadataManager.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+        MetadataExplorer.__init__(
+            self, view_server, platform_url, user_id, user_pwd, token
+        )
+
+
+if __name__ == "__main__":
+    print("Main-Tech Client")