pyegeria 5.3.3.10.dev5__py3-none-any.whl → 5.3.3.10.dev7__py3-none-any.whl

pyegeria/__init__.py

@@ -68,12 +68,13 @@ from .create_tech_guid_lists import build_global_guid_lists
 from .classification_manager_omvs import ClassificationManager
 from .feedback_manager_omvs import FeedbackManager
 from .metadata_explorer_omvs import MetadataExplorer
-from .mermaid_utilities import load_mermaid, render_mermaid, generate_process_graph, check_mermaid_version
+from .mermaid_utilities import load_mermaid, render_mermaid, generate_process_graph
 from .egeria_my_client import EgeriaMy
 from .egeria_cat_client import EgeriaCat
 from .egeria_tech_client import EgeriaTech
 from .egeria_config_client import EgeriaConfig
 from .egeria_client import Egeria
+from .solution_architect_omvs import SolutionArchitect
 
 
 #

pyegeria/_client.py

@@ -10,6 +10,8 @@ import asyncio
 import inspect
 import json
 import os
+from datetime import datetime
+
 from pyegeria import body_slimmer
 import httpx
 from httpx import AsyncClient, Response
@@ -469,7 +471,7 @@ class Client:
                 msg = OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
                     "message_template"
                 ].format(
-                    str(response.status_code),
+                    str(response.status_code) + " " + datetime.now().strftime("%H: %M: %S") ,
                     caller_method,
                     class_name,
                     endpoint,

pyegeria/classification_manager_omvs.py

@@ -1547,6 +1547,8 @@ class ClassificationManager(Client):
         UserNotAuthorizedException
             the requesting user is not authorized to issue this request.
         """
+        if property_value is '*':
+            property_value = None
 
         possible_query_params = query_string(
             [

pyegeria/commands/cat/get_information_supply_chains.py

@@ -0,0 +1,207 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for Information Supply Chains
+
+"""
+
+import argparse
+import os
+from datetime import time
+
+from rich import print, box
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.tree import Tree
+from pyegeria.solution_architect_omvs import SolutionArchitect
+from pyegeria import (
+    ProjectManager,
+    UserNotAuthorizedException,
+    PropertyServerException,
+    InvalidParameterException, ClassificationManager, SolutionArchitect,
+    )
+from pyegeria._exceptions import (
+    print_exception_response,
+)
+
+disable_ssl_warnings = True
+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("EGERIA_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 supply_chain_viewer(
+    search_string: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    timeout: int = 30,
+):
+    """A Supply Chain viewer"""
+
+    def display_supply_chains(supply_chains: list[dict] ) -> Table:
+        table = Table(
+            title=f"Supply Chains matching  {search_string} @ {time.asctime()}",
+            style="bright_white on black",
+            header_style="bright_white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server_name}' @ Platform - {platform_url}",
+            expand=True,
+            )
+        table.add_column("Supply Chain Name")
+        table.add_column("Qualified Name / GUID", width=38, no_wrap=True)
+        table.add_column("Purpose")
+        table.add_column("Scope")
+        table.add_column("Description")
+
+        for sc in supply_chains:
+            sc_name = sc["properties"].get("displayName", '---')
+            sc_qname = sc["elementHeader"]["qualifiedName"]
+            sc_guid = sc["elementHeader"]["guid"]
+            sc_purpose = sc["properties"].get("purposes",'---')
+            sc_scope = sc["properties"].get("scope",'---')
+            sc_desc = sc["properties"].get("description",'---')
+            sc_unique_name = f"\t{sc_qname}\n\t/\n\t{sc_guid}"
+            table.add_row(sc_name, sc_unique_name, sc_purpose, sc_scope, sc_desc)
+
+        return table
+
+
+    def walk_project_hierarchy(
+        project_client: ProjectManager,
+        project_name: str,
+        tree: Tree,
+        root: bool = False,
+    ) -> None:
+        """Recursively build a Tree with collection contents."""
+        t = None
+        style = "bright_white on black"
+
+        project = project_client.get_projects_by_name(project_name)
+        if type(project) is list:
+            proj_guid = project[0]["elementHeader"]["guid"]
+            proj_props = project[0]["properties"]
+
+            proj_type = proj_props.get("typeName", "---")
+            proj_unique = proj_props.get("qualifiedName", "---")
+            proj_identifier = proj_props.get("identifier", "---")
+            proj_name = proj_props.get("name", "---")
+            proj_desc = proj_props.get("description", "---")
+            proj_status = proj_props.get("projectStatus", "---")
+            proj_priority = proj_props.get("priority", "---")
+            proj_start = proj_props.get("startDate", "---")[:-10]
+            proj_props_md = (
+                f"* Name: {proj_name}\n"
+                f"* Identifier: {proj_identifier}\n"
+                f"* Type: {proj_type}\n"
+                f"* Status: {proj_status}\n"
+                f"* priority: {proj_priority}\n"
+                f"* Start:    {proj_start}\n"
+                f"* Description: {proj_desc}\n"
+                f"* GUID: {proj_guid}"
+            )
+        else:
+            return
+
+        team = project_client.get_project_team(proj_guid)
+        member_md = ""
+        if type(team) is list:
+            for member in team:
+                member_guid = member["member"]["guid"]
+                member_unique = member["member"]["uniqueName"]
+                member_md += f"* Member Unique Name: {member_unique}\n* Member GUID: {member_guid}"
+            proj_props_md += f"\n### Team Members\n {member_md}"
+
+        proj_props_out = Markdown(proj_props_md)
+        p = Panel.fit(proj_props_out, style=style, title=project_name)
+        t = tree.add(p)
+
+        linked_projects = project_client.get_linked_projects(proj_guid)
+        if type(linked_projects) is list:
+            for proj in linked_projects:
+                child_md = ""
+                child_guid = proj["elementHeader"]["guid"]
+                child_name = proj["properties"]["name"]
+                relationship = proj["relatedElement"]["relationshipHeader"]["type"][
+                    "typeName"
+                ]
+                if relationship != "ProjectDependency":
+                    continue
+                walk_project_hierarchy(project_client, child_name, t)
+
+        else:
+            return t
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+        tree = Tree(
+            f"[bold bright green on black]Supply Chains containing: {search_string}", guide_style="bold bright_blue"
+        )
+        client = SolutionArchitect(server_name, platform_url, user, user_password)
+
+        token = client.create_egeria_bearer_token()
+
+        sc = client.find_all_information_supply_chains(search_string)
+
+        if (isinstance(sc, list)):
+            t = tree.add(display_supply_chains(sc))
+        else:
+            t = tree.add(type(sc))
+        # walk_project_hierarchy(p_client, root, tree, root=True)
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+
+
+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_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        search_string = Prompt.ask(
+            "Enter a search string:", default="*"
+        )
+        supply_chain_viewer(search_string, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/ops/monitor_server_status.py

@@ -81,7 +81,7 @@ def display_status(
             table.add_column("Description")
             table.add_column("Server Type")
             table.add_column("Last Started")
-        token = p_client.create_egeria_bearer_token()
+
         platform_list = p_client.get_platforms_by_type()
         if type(platform_list) is str:
             print("No OMAG Server Platforms found?")
@@ -139,11 +139,14 @@ def display_status(
                         "[red]Inactive" "" if status == "Inactive" else "[green]Active",
                         # server_status,
                     )
-        # p_client.close_session()
+        p_client.refresh_egeria_bearer_token()
         return table
 
     try:
-        with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        # with Live(generate_table(), refresh_per_second=1, screen=True) as live:
+        print(f" Started at {time.asctime()} \n")
+        with Live(generate_table(), refresh_per_second=4, screen=False, transient=False) as live:
+
             while True:
                 time.sleep(5)
                 live.update(generate_table())

pyegeria/mermaid_utilities.py

@@ -43,23 +43,23 @@ EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
 
 
 # Check Mermaid.js version
-def check_mermaid_version():
-    """Check the version of Mermaid.js loaded in Jupyter Notebook"""
-    display(HTML("""
-    <script>
-        function checkMermaid() {
-            if (window.mermaid && typeof window.mermaid.version !== "undefined") {
-                console.log("Mermaid.js version:", mermaid.version);
-                alert("Mermaid.js version: " + mermaid.version);
-            } else {
-                console.warn("Mermaid.js is not loaded yet. Please ensure it's properly injected.");
-                alert("Mermaid.js is not loaded yet. Please ensure it's properly injected.");
-            }
-        }
-        // Delay execution to ensure Mermaid.js has had time to load
-        setTimeout(checkMermaid, 1000);
-    </script>
-    """))
+# def check_mermaid_version():
+#     """Check the version of Mermaid.js loaded in Jupyter Notebook"""
+#     display(HTML("""
+#     <script>
+#         function checkMermaid() {
+#             if (window.mermaid && typeof window.mermaid.version !== "undefined") {
+#                 console.log("Mermaid.js version:", mermaid.version);
+#                 alert("Mermaid.js version: " + mermaid.version);
+#             } else {
+#                 console.warn("Mermaid.js is not loaded yet. Please ensure it's properly injected.");
+#                 alert("Mermaid.js is not loaded yet. Please ensure it's properly injected.");
+#             }
+#         }
+#         // Delay execution to ensure Mermaid.js has had time to load
+#         setTimeout(checkMermaid, 1000);
+#     </script>
+#     """))
 
 # another site to get mermaid from is "https://cdnjs.cloudflare.com/ajax/libs/mermaid/11.4.1/mermaid.min.js";
 # below was:

pyegeria/metadata_explorer_omvs.py

@@ -489,49 +489,6 @@ class MetadataExplorer(Client):
         )
         return response
 
-    # def get_metadata_element_mermaid_graph(
-    #     self,
-    #     guid: str,
-    #     effective_time: str = None,
-    #     as_of_time: str = None,
-    #     for_lineage: bool = None,
-    #     for_duplicate_processing: bool = None,
-    # ) -> dict | str:
-    #     """
-    #     Retrieve the metadata element using its unique identifier.
-    #
-    #     Parameters
-    #     ----------
-    #     guid : str
-    #         - unique identifier of the element to retrieve
-    #     effective_time: str, default = None
-    #         - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
-    #     as_of_time: str, default = None
-    #         - Query the element as of this time. If None, then use current time.
-    #     for_lineage: bool, default is set by server
-    #         - determines if elements classified as Memento should be returned - normally false
-    #     for_duplicate_processing: bool, default is set by server
-    #         - Normally false. Set true when the caller is part of a deduplication function
-    #
-    #     Returns
-    #     -------
-    #     dict | str
-    #         If the element is found, a dict of the element details is returned. Otherwise the string "No element found".
-    #
-    #     Raises
-    #     ------
-    #     InvalidParameterException
-    #         one of the parameters is null or invalid or
-    #     PropertyServerException
-    #         There is a problem adding the element properties to the metadata repository or
-    #     UserNotAuthorizedException
-    #         the requesting user is not authorized to issue this request.
-    #     """
-    #
-    #     response = self.get_metadata_element_graph(
-    #         guid, effective_time, as_of_time, for_lineage, for_duplicate_processing
-    #     )
-    #     return response.get("mermaidGraph", NO_ELEMENTS_FOUND)
 
     async def _async_get_metadata_element_by_unique_name(
         self,

pyegeria/solution_architect_omvs.py

@@ -0,0 +1,639 @@
+"""PDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+This module provides access to the metadata-explorer OMVS module.
+
+https://egeria-project.org/concepts/information-supply-chain
+
+"""
+
+import asyncio
+
+from httpx import Response
+
+from pyegeria import body_slimmer
+from pyegeria._client import Client, max_paging_size
+
+NO_ELEMENTS_FOUND = "No Elements Found"
+
+DEFAULT_BODY_SKELETON = {
+    'effective_time' :  None,
+    'limitResultsByStatus' : ['ACTIVE'],
+    'asOfTime' : None,
+    'sequencingOrder' : None,
+    'sequencingProperty' : None,
+    'filter' : None
+    }
+
+def query_seperator(current_string):
+    if current_string == "":
+        return "?"
+    else:
+        return "&"
+
+
+"params are in the form of [(paramName, value), (param2Name, value)] if the value is not None, it will be added to the query string"
+
+
+def query_string(params):
+    result = ""
+    for i in range(len(params)):
+        if params[i][1] is not None:
+            result = f"{result}{query_seperator(result)}{params[i][0]}={params[i][1]}"
+    return result
+
+
+def base_path(client, view_server: str):
+    return f"{client.platform_url}/servers/{view_server}/api/open-metadata/metadata-explorer"
+
+
+class SolutionArchitect(Client):
+    """SolutionArchitect is a class that extends the Client class. The Solution Architect OMVS provides APIs for
+      searching for architectural elements such as information supply chains, solution blueprints, solution components
+      and component implementations.
+
+    Attributes:
+
+        view_server: str
+            The name of the View Server to connect to.
+        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
+
+
+    """
+
+    def __init__(
+        self,
+        view_server: str,
+        platform_url: str,
+        user_id: str = None,
+        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
+        self.solution_architect_command_root: str = (f"{self.platform_url}/servers/{self.view_server}"
+                                                     f"/api/open-metadata/solution-architect")
+        Client.__init__(
+            self,
+            view_server,
+            platform_url,
+            user_id=user_id,
+            user_pwd=user_pwd,
+            token=token,
+        )
+
+    #
+    #
+    #
+
+    async def _async_find_information_supply_chains(self,
+                                                    filter: str = "*",
+                                                    starts_with: bool = True,
+                                                    ends_with: bool = False,
+                                                    ignore_case: bool = False,
+                                                    start_from: int = 0,
+                                                    page_size: int = max_paging_size,
+                                                    body: dict = None,) ->list[dict] | str:
+
+        """Retrieve the list of information supply chain metadata elements that contain the search string.
+           https://egeria-project.org/concepts/information-supply-chain
+           Async version.
+
+        Parameters
+        ----------
+        filter : str
+            - search_filter string to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of information supply chain structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        possible_query_params = query_string(
+            [
+                ("startFrom", start_from),
+                ("pageSize", page_size),
+                ("startsWith", starts_with),
+                ("endsWith", ends_with),
+                ("ignoreCase", ignore_case),
+            ]
+        )
+
+        if filter is None or filter == "*":
+            search_filter = None
+        else:
+            search_filter = filter
+
+        if body is None:
+            body = {
+                "filter": search_filter,
+            }
+        else:
+            body["filter"] = search_filter
+
+        url = (
+            f"{self.solution_architect_command_root}/information-supply-chains/by-search-string"
+            f"{possible_query_params}"
+        )
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body)
+        )
+        return response.json().get("elements", NO_ELEMENTS_FOUND)
+
+    def find_information_supply_chains(self,
+                                           filter: str = "*",
+                                           starts_with: bool = True,
+                                           ends_with: bool = False,
+                                           ignore_case: bool = False,
+                                           start_from: int = 0,
+                                           page_size: int = max_paging_size,
+                                           body: dict = None) -> list[dict] | str:
+
+        """Retrieve the list of information supply chain metadata elements that contain the search string.
+          https://egeria-project.org/concepts/information-supply-chain
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of information supply chain structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_find_information_supply_chains(
+                filter,
+                starts_with,
+                ends_with,
+                ignore_case,
+                start_from,
+                page_size,
+                body,)
+        )
+        return response
+
+
+    def find_all_information_supply_chains(self, start_from: int = 0, page_size: int = max_paging_size) \
+            -> list[dict] | str:
+       """Retrieve a list of all information supply chains
+          https://egeria-project.org/concepts/information-supply-chain
+       """
+
+       return (self.find_information_supply_chains('*', start_from = start_from, page_size = page_size ))
+
+
+
+    async def _async_find_solution_blueprints(self,
+                                              filter: str = "*",
+                                              starts_with: bool = True,
+                                              ends_with: bool = False,
+                                              ignore_case: bool = False,
+                                              start_from: int = 0,
+                                              page_size: int = max_paging_size,
+                                              body: dict = None,) ->list[dict] | str:
+
+        """Retrieve the solution blueprint elements that contain the search string.
+           https://egeria-project.org/concepts/solution-blueprint
+           Async version.
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of solution blueprint structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        possible_query_params = query_string(
+            [
+                ("startFrom", start_from),
+                ("pageSize", page_size),
+                ("startsWith", starts_with),
+                ("endsWith", ends_with),
+                ("ignoreCase", ignore_case),
+            ]
+        )
+
+        if filter is None or filter== "*":
+            search_filter = None
+        else:
+            search_filter = filter
+
+        if body is None:
+            body = {
+                "filter": search_filter,
+            }
+        else:
+            body["filter"] = search_filter
+
+        url = (
+            f"{self.solution_architect_command_root}/solution-blueprints/by-search-string"
+            f"{possible_query_params}"
+        )
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body)
+        )
+        return response.json().get("elements", NO_ELEMENTS_FOUND)
+
+    def find_solution_blueprints(self,
+                                 filter: str = "*",
+                                 starts_with: bool = True,
+                                 ends_with: bool = False,
+                                 ignore_case: bool = False,
+                                 start_from: int = 0,
+                                 page_size: int = max_paging_size,
+                                 body: dict = None) -> list[dict] | str:
+
+        """Retrieve the list of solution blueprint elements that contain the search string.
+           https://egeria-project.org/concepts/solution-blueprint
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of information supply chain structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_find_solution_blueprints(
+                filter,
+                starts_with,
+                ends_with,
+                ignore_case,
+                start_from,
+                page_size,
+                body,)
+        )
+        return response
+
+    def find_all_solution_blueprints(self, start_from: int = 0, page_size: int = max_paging_size) \
+            -> list[dict] | str:
+        """Retrieve a list of all solution blueprint elements
+        https://egeria-project.org/concepts/solution-blueprint
+        """
+        return (self.find_solution_blueprints('*', start_from = start_from, page_size = page_size ))
+
+
+    async def _async_find_solution_roles(self,
+                                         filter: str = "*",
+                                         starts_with: bool = True,
+                                         ends_with: bool = False,
+                                         ignore_case: bool = False,
+                                         start_from: int = 0,
+                                         page_size: int = max_paging_size,
+                                         body: dict = None,) ->list[dict] | str:
+
+        """Retrieve the solutio nrole elements that contain the search string.
+           https://egeria-project.org/concepts/actor
+           Async version.
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of solution role structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        possible_query_params = query_string(
+            [
+                ("startFrom", start_from),
+                ("pageSize", page_size),
+                ("startsWith", starts_with),
+                ("endsWith", ends_with),
+                ("ignoreCase", ignore_case),
+            ]
+        )
+
+        if filter is None or filter== "*":
+            search_filter = None
+        else:
+            search_filter = filter
+
+        if body is None:
+            body = {
+                "filter": search_filter,
+            }
+        else:
+            body["filter"] = search_filter
+
+        url = (
+            f"{self.solution_architect_command_root}/solution-roles/by-search-string"
+            f"{possible_query_params}"
+        )
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body)
+        )
+        return response.json().get("elements", NO_ELEMENTS_FOUND)
+
+    def find_solution_roles(self,
+                            filter: str = "*",
+                            starts_with: bool = True,
+                            ends_with: bool = False,
+                            ignore_case: bool = False,
+                            start_from: int = 0,
+                            page_size: int = max_paging_size,
+                            body: dict = None) -> list[dict] | str:
+
+        """Retrieve the list of solution role elements that contain the search string.
+           https://egeria-project.org/concepts/actor
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of information supply chain structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_find_solution_roles(
+                filter,
+                starts_with,
+                ends_with,
+                ignore_case,
+                start_from,
+                page_size,
+                body,)
+        )
+        return response
+
+    def find_all_solution_roles(self, start_from: int = 0, page_size: int = max_paging_size) \
+            -> list[dict] | str:
+        """Retrieve a list of all solution blueprint elements
+           https://egeria-project.org/concepts/actor
+        """
+        return (self.find_solution_roles('*', start_from = start_from, page_size = page_size ))
+
+
+
+    async def _async_find_solution_components(self,
+                                              filter: str = "*",
+                                              starts_with: bool = True,
+                                              ends_with: bool = False,
+                                              ignore_case: bool = False,
+                                              start_from: int = 0,
+                                              page_size: int = max_paging_size,
+                                              body: dict = None,) ->list[dict] | str:
+
+        """Retrieve the solution component elements that contain the search string.
+           https://egeria-project.org/concepts/solution-components
+           Async version.
+
+        Parameters
+        ----------
+        filter: str
+            - search_filterstring to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of solution blueprint structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        possible_query_params = query_string(
+            [
+                ("startFrom", start_from),
+                ("pageSize", page_size),
+                ("startsWith", starts_with),
+                ("endsWith", ends_with),
+                ("ignoreCase", ignore_case),
+            ]
+        )
+
+        if filter is None or filter== "*":
+            search_filter = None
+        else:
+            search_filter = filter
+
+        if body is None:
+            body = {
+                "filter": search_filter,
+            }
+        else:
+            body["filter"] = search_filter
+
+        url = (
+            f"{self.solution_architect_command_root}/solution-components/by-search-string"
+            f"{possible_query_params}"
+        )
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body)
+        )
+        return response.json().get("elements", NO_ELEMENTS_FOUND)
+
+    def find_solution_components(self,
+                                 filter: str = "*",
+                                 starts_with: bool = True,
+                                 ends_with: bool = False,
+                                 ignore_case: bool = False,
+                                 start_from: int = 0,
+                                 page_size: int = max_paging_size,
+                                 body: dict = None) -> list[dict] | str:
+
+        """Retrieve the list of solution component elements that contain the search string.
+           https://egeria-project.org/concepts/solution-components
+
+        Parameters
+        ----------
+        filter : str
+            - filter string to search for.
+        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
+        body: dict, optional, default = None
+            - additional optional specifications for the search.
+
+        Returns
+        -------
+        list[dict] | str
+            A list of information supply chain structures or a string if there are no elements found.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_find_solution_components(
+                filter,
+                starts_with,
+                ends_with,
+                ignore_case,
+                start_from,
+                page_size,
+                body,)
+        )
+        return response
+
+    def find_all_solution_components(self, start_from: int = 0, page_size: int = max_paging_size) \
+            -> list[dict] | str:
+        """Retrieve a list of all solution component elements
+           https://egeria-project.org/concepts/solution-components
+        """
+        return (self.find_solution_components('*', start_from = start_from, page_size = page_size ))
+
+
+
+
+
+
+if __name__ == "__main__":
+    print("Main-Metadata Explorer")

{pyegeria-5.3.3.10.dev5.dist-info → pyegeria-5.3.3.10.dev7.dist-info}/METADATA

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

{pyegeria-5.3.3.10.dev5.dist-info → pyegeria-5.3.3.10.dev7.dist-info}/RECORD

@@ -1,14 +1,14 @@
 pyegeria/.DS_Store,sha256=NXvKqE04FGJAyq25tRApO9AJj14vF1vzFC-R0JjEWhc,6148
 pyegeria/README.md,sha256=PwX5OC7-YSZUCIsoyHh1O-WBM2hE84sm3Bd4O353NOk,1464
-pyegeria/__init__.py,sha256=tz1P5kqvvPpSUDWTTP6aFdi8jLc5lV5yWvlxjHddXtU,21970
-pyegeria/_client.py,sha256=9yZfSyLJqq5ORlM7NzeaozXjPX0i9YsfD2Ue3mN9Y9Q,30811
+pyegeria/__init__.py,sha256=88x7BHHZ7iK3EoNUl-GaI4Lu_8PeLbpKhv1FrBQ87Rk,22002
+pyegeria/_client.py,sha256=Hj8Tmo6DuKJPLROZrUw7NXzo7O_BgbewlvRwJZPKPBA,30889
 pyegeria/_deprecated_gov_engine.py,sha256=dWNcwVsE5__dF2u4QiIyQrssozzzOjBbLld8MdpmVCQ,17264
 pyegeria/_exceptions.py,sha256=NJ7vAhmvusK1ENvY2MMrBB6A6TgpYjzS9QJxFH56b8c,18470
 pyegeria/_globals.py,sha256=1Uc8392wjbiVN5L__RzxC1-U97RMXj77_iUsMSgeAjQ,638
 pyegeria/_validators.py,sha256=rnZelHJnjHaLZ8UhUTDyB59MfIUJifhALtkYoHBaos4,12736
 pyegeria/asset_catalog_omvs.py,sha256=OqZYjf5RBwuTbYvu43CL100VCNqYuXHDog2jc6sOBtA,25580
 pyegeria/automated_curation_omvs.py,sha256=fFZef1GeUNBSFIC8QltpzkQs_W5OD0xVYW1TzW07UWc,130239
-pyegeria/classification_manager_omvs.py,sha256=rHkcpzPeQqH1XmlbXnWtAJeG6mVMIL_N9ZGn13kR30U,187155
+pyegeria/classification_manager_omvs.py,sha256=W1ShZyZ4nOJF_kZbGJR5cH3K5_z1Vg5h9f68Qc2zXLI,187223
 pyegeria/collection_manager_omvs.py,sha256=Zl3clg29bORkfBDunklgna0cIceF278njqzDW9pUJwk,101697
 pyegeria/commands/.DS_Store,sha256=9m3ajPPW2e7MhodsfTR2-KL9opdeTap-MlUAb3x9aR4,8196
 pyegeria/commands/README.md,sha256=hJdOWhZ5eCfwTkY4Tx6De6Y1XVo7cbaddQEvjqppvls,2036
@@ -41,6 +41,7 @@ pyegeria/commands/cat/__pycache__/list_user_ids.cpython-312.pyc,sha256=d03sLltHH
 pyegeria/commands/cat/exp_list_glossaries.py,sha256=HxMa5r7XxsH29KJ9GLOqIXD_PpUvrzsHe41LBWCZUTc,5811
 pyegeria/commands/cat/get_asset_graph.py,sha256=tHTib3AjbXzrGkOHE2SO51O_ARPjmmDq1UDbE8XSd7o,12454
 pyegeria/commands/cat/get_collection.py,sha256=ukUZA4Ot_Gjaym6LmFiWoGezshbcygJPowwHLooVHck,5359
+pyegeria/commands/cat/get_information_supply_chains.py,sha256=aXYmQ8tTY1NYCrFRM0K4-ui1vtkTB1UGTGZKaRNLTmc,7626
 pyegeria/commands/cat/get_project_dependencies.py,sha256=NCUTAHAzScjQwoAHLf1DC9rGPg53VfjaTR96eahgjq8,5988
 pyegeria/commands/cat/get_project_structure.py,sha256=h6q5Ps3xRhV2Zqh6295nDCgVThUrWX5O-JC0qaSIM5s,5976
 pyegeria/commands/cat/get_tech_type_elements.py,sha256=9F0wBy8ireLFHLNChxkM4A7xJ4uFL4XKdXlm6roDk2I,6185
@@ -233,7 +234,7 @@ pyegeria/commands/ops/monitor_gov_eng_status.py,sha256=nSPZscEFnlljaA4AMNQqhY2Sy
 pyegeria/commands/ops/monitor_integ_daemon_status.py,sha256=1HPJHIrBIohJPPw0wHae2rvGgLSmgMgucRujcug5Qwk,11768
 pyegeria/commands/ops/monitor_platform_status.py,sha256=J_DdUDWv2FtY9DeJamdnWJmFK6Ua9L1GU_yFvb-zcTc,7180
 pyegeria/commands/ops/monitor_server_startup.py,sha256=bvLqxoRiw9tJzNtChZ70a5w_23UyJLlrlmbMnmZ5QN4,3908
-pyegeria/commands/ops/monitor_server_status.py,sha256=ZEi4HUSXVgN0z25dvfIRiY6V6kARsaz7daz9uG0RKbA,7005
+pyegeria/commands/ops/monitor_server_status.py,sha256=WtxI34FVPDxF74VpHUNQ_sdzdMMi3wn62-rFOQHKYDY,7115
 pyegeria/commands/ops/orig_monitor_server_list.py,sha256=tHGigEuUVZ8OA4ut5UscYK9HHeQevQ_MlIkE4XHYER8,4644
 pyegeria/commands/ops/orig_monitor_server_status.py,sha256=povaYQ-Y8QJvwaFuWp_BLUThjjTTbmu-21h7zi8NlWk,4026
 pyegeria/commands/ops/refresh_integration_daemon.py,sha256=aOIy7xsYfNwuiZ-8aXcd2RoRaBkakYQF5JPIWz1dlxE,2969
@@ -292,20 +293,21 @@ pyegeria/feedback_manager_omvs.py,sha256=B66e3ZCaC_dirb0mcb2Nz3PYh2ZKsoMAYNOb3eu
 pyegeria/full_omag_server_config.py,sha256=k3fUfopAFAE3OKkFR7zZPiki_FYj6j2xQ4oD2SVaefQ,47350
 pyegeria/glossary_browser_omvs.py,sha256=NcitYaZJqwVODBO5zBtWpXPNUJJ3DKzEbRaOFSAyUlg,93554
 pyegeria/glossary_manager_omvs.py,sha256=tBjoHrrHJLasXoeQSpW-KpF3vEQdN_GR3jfcceTjt_c,132444
-pyegeria/mermaid_utilities.py,sha256=iHsLYJ4VBER71HnVn1K4FRDyZRGnlwwyAdZXphpnjC4,9898
-pyegeria/metadata_explorer_omvs.py,sha256=WwkFvAnDzJTw8dPos7j3wCG6gpQ0BjcMmYXl-ckjn28,88723
+pyegeria/mermaid_utilities.py,sha256=O5qNAWZSiIWoti8SU16Hh6xhtA-CdIiZuZ_Qr7JJ9NQ,9932
+pyegeria/metadata_explorer_omvs.py,sha256=XBg6q-JXOA8UYsT85nlpBVe4EQ6jxwj70MvE7tkVvH0,86905
 pyegeria/my_profile_omvs.py,sha256=DyECbUFEcgokrIbzdMMNljC3bqfqKGXAF2wZEpzvRYs,34666
 pyegeria/platform_services.py,sha256=CJIOYIFEbcIGwdWlApAQcXxZTsdrhFtpJcm4O3p7dG0,41646
 pyegeria/project_manager_omvs.py,sha256=Y7Lyqh4jIujJrr_Ub7feo904FN_uz4R10T4hKhqE1Uw,67499
 pyegeria/registered_info.py,sha256=y0-LgDIQXpph0lEWxIOG3_HsqX_Z2iAIb3xu4Aa4B70,6344
 pyegeria/runtime_manager_omvs.py,sha256=sZfxgM7zVfryVsun5GwDpUT5htap91ZoZLNU7wspWm4,79575
 pyegeria/server_operations.py,sha256=PfH0wvWCOr43ezJAAXj7VEUdT0x_oTrfr0dzzQvcQk4,16766
+pyegeria/solution_architect_omvs.py,sha256=MHsWBgrYfwPSCoWZ_50MJJ_htNWMOZrkR0YyFzFjqtE,23141
 pyegeria/template_manager_omvs.py,sha256=Sw5xsQAhy7a48xFCg59mg9_nqyhawoS9v4WyF-PjPqM,42425
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
 pyegeria/valid_metadata_omvs.py,sha256=cCt5CCLv6BdzCu90n68r_PkG_PEQJjrtwCxio7K6yko,65034
 pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
-pyegeria-5.3.3.10.dev5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-5.3.3.10.dev5.dist-info/METADATA,sha256=W203LpGyogogb8Zq5ekI88NvIqpHNjCRu1ekEjAlw1w,2741
-pyegeria-5.3.3.10.dev5.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pyegeria-5.3.3.10.dev5.dist-info/entry_points.txt,sha256=sqVSCsr2oVnXtKTgRs5_F9OjbtexhmaXE330sO8V9bk,5873
-pyegeria-5.3.3.10.dev5.dist-info/RECORD,,
+pyegeria-5.3.3.10.dev7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-5.3.3.10.dev7.dist-info/METADATA,sha256=345cHQkEVhyO-WCImF98k_7Umsy_cIPrWwOsLrEB3xU,2741
+pyegeria-5.3.3.10.dev7.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pyegeria-5.3.3.10.dev7.dist-info/entry_points.txt,sha256=sqVSCsr2oVnXtKTgRs5_F9OjbtexhmaXE330sO8V9bk,5873
+pyegeria-5.3.3.10.dev7.dist-info/RECORD,,