pyegeria 0.6.3__py3-none-any.whl → 0.6.5__py3-none-any.whl

examples/widgets/cat/get_project_structure.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for collections - provide the root and we display the hierarchy
+
+"""
+
+import argparse
+import os
+from rich import print
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.text import Text
+from rich.tree import Tree
+
+from pyegeria import ProjectManager, UserNotAuthorizedException, PropertyServerException, InvalidParameterException
+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('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 project_structure_viewer(root: str, server_name: str, platform_url: str, user: str, user_password: str,
+                      jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH):
+    """ A simple collection viewer"""
+    def walk_project_hierarchy(project_client: ProjectManager, root_project_name: str, tree: Tree) -> None:
+        """Recursively build a Tree with collection contents."""
+        project = project_client.get_projects_by_name(root_project_name)
+        if type(project) is list:
+            root_guid = project['elementHeader']['guid']
+            proj_props = project['properties']
+            proj_props_md = ""
+            for key in proj_props.keys():
+                proj_props_md += f"* {key}: {proj_props[key]}\n"
+
+        t = tree.add()
+
+
+        members = project_client.get_member_list(root_collection_name)
+        if members:
+            for member in members:
+                style = "bold white on black"
+                text_collection_name = Text(f"[bold white on black]Name: {member['name']}", style=style)
+                text_qualified_name = Text(f"* QualifiedName: {member['qualifiedName']}")
+                text_guid = Text(f"* GUID: {member['guid']}", "green")
+                text_collection_type = Text(f"* Collection Type: {member['collectionType']}")
+                text_description = Text(f"* Description: {member['description']}")
+                p = Panel.fit(f"{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
+                              f"{text_collection_type}\n{text_description}")
+                tt = tree.add(p, style=style)
+
+                children = collection_client.get_collection_members(member['guid'])
+                if type(children) is list:
+                    branch = tt.add(f"[bold magenta on black]Members", style=style, guide_style=style)
+                    walk_collection_hierarchy(collection_client, member['qualifiedName'], branch),
+        else:
+            tt = tree.add(f"[bold magenta on black]No collections match {root_collection_name}")
+    try:
+        tree = Tree(f"[bold bright green on black]{root}",guide_style="bold bright_blue")
+        p_client = ProjectManager(server_name, platform_url,
+                                     user_id=user)
+
+        token = p_client.create_egeria_bearer_token(user, user_password)
+        walk_project_hierarchy(p_client, root, tree)
+        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:
+        root_project = Prompt.ask("Enter the Root Project to start from:", default="Sustainability Campaign")
+        project_structure_viewer(root_project, server, url, userid, user_pass)
+    except (KeyboardInterrupt):
+        pass
+if __name__ == "__main__":
+    main()

examples/widgets/cat/list_cert_types.py

@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List certification types
+
+
+A simple display for certification types
+"""
+import argparse
+import os
+import sys
+import time
+import json
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.markdown import Markdown
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AssetCatalog,
+    ClassificationManager
+)
+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'))
+
+
+disable_ssl_warnings = True
+
+
+def display_certifications(search_string: str, server: str, url: str, username: str, user_password: str, time_out: int = 60,
+                   jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH):
+    console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
+    if (search_string is None) or ((len(search_string) < 3)) and (search_string != '*'):
+        raise ValueError("Invalid Search String - must be greater than four characters long")
+    g_client = ClassificationManager(server, url, user_id=username,user_pwd=user_password )
+    token = g_client.create_egeria_bearer_token(username, user_password)
+
+
+    def generate_table(search_string:str = None) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Certifications Types  @ {time.asctime()}",
+            header_style="white on dark_blue",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Title", max_width=15)
+        table.add_column('summary')
+        table.add_column("domainID")
+        table.add_column("Unique Name")
+        table.add_column("Scope")
+        # table.add_column("Qualified Name",max_width=15)
+        table.add_column("Description")
+        table.add_column("Details")
+        table.add_column("Related Elements")
+
+
+        certs = g_client.get_elements(search_string, page_size=100, time_out=time_out)
+        if type(certs) is str:
+            return table
+
+        for element in certs:
+            properties = element['properties']
+            summary = properties.get('summary',"---")
+            domain = properties.get("domainIdentifier",'---')
+            unique_name = properties.get('qualifiedName','---')
+            scope = properties.get('scope','---')
+            description = properties.get('description','---')
+            details = properties.get('details','---')
+            title = properties.get('title','---')
+            cert_guid = element['elementHeader']['guid']
+
+            related = g_client.get_all_related_elements(cert_guid)
+            if (len(related) > 0) and (type(related) is list):
+                rel_md = ''
+                for rel in related:
+                    rel_type = rel['relationshipHeader']['type']['typeName']
+                    rel_element_props = rel['relatedElement']['properties']
+                    rel_el_md = f"* Rel Type: {rel_type}\n"
+                    for key in rel_element_props.keys():
+                        rel_el_md += f"* {key}: {rel_element_props[key]}\n"
+                    rel_md += f"----\n{rel_el_md}\n"
+            else:
+                rel_md = '---'
+
+            # match_tab = Table(expand=True)
+            # match_tab.add_column("Type Name")
+            # match_tab.add_column("GUID", no_wrap=True, width=36)
+            # match_tab.add_column("Properties")
+            #
+            # for match in nested:
+            #     match_type_name = match['type']['typeName']
+            #     matching_guid = match['guid']
+            #     match_props = match['properties']
+            #     match_details_md = ""
+            #     for key in match_props.keys():
+            #         match_details_md += f"* {key}: {match_props[key]}\n"
+            #     match_details_out = Markdown(match_details_md)
+            #     match_tab.add_row(match_type_name, matching_guid, match_details_out)
+
+
+            table.add_row(
+                title, summary, domain, unique_name,scope,description,details, rel_md
+            )
+
+        g_client.close_session()
+
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+
+        with console.pager(styles=True):
+            console.print(generate_table(search_string), soft_wrap=True)
+
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        console.print_exception()
+        sys.exit(1)
+
+    except ValueError as e:
+        console.print(f"\n\n====> Invalid Search String - must be greater than four characters long")
+        sys.exit(1)
+
+
+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")
+    parser.add_argument("--time_out", help="Time Out")
+
+    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
+    time_out = args.time_out if args.time_out is not None else 60
+    try:
+        # search_string = Prompt.ask("Enter an asset search string:", default="*")
+        search_string = 'CertificationType'
+        display_certifications(search_string, server, url, userid, user_pass, time_out)
+    except(KeyboardInterrupt):
+        pass
+
+if __name__ == "__main__":
+    main()

examples/widgets/cat/list_projects.py

@@ -26,7 +26,7 @@ from pyegeria import (
     UserNotAuthorizedException,
     print_exception_response,
 )
-from pyegeria import ProjectManager
+from pyegeria import ProjectManager, ClassificationManager
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
 EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
@@ -48,6 +48,7 @@ def display_project_list(project_name: str, server: str, url: str,
                          width: int = EGERIA_WIDTH):
     p_client = ProjectManager(server, url, user_id=username)
     token = p_client.create_egeria_bearer_token(username, user_pass)
+    c_client = ClassificationManager(server, url, token)
 
     def generate_table(project_name: str) -> Table:
         """Make a new table."""
@@ -60,7 +61,7 @@ def display_project_list(project_name: str, server: str, url: str,
             expand=True
         )
 
-        table.add_column("Display Name")
+        table.add_column("Project Name")
         table.add_column("Description")
 
         table.add_column("Classifications")
@@ -111,9 +112,25 @@ def display_project_list(project_name: str, server: str, url: str,
                 additional_properties = project.get('additionalProperties')
                 if additional_properties is not None:
                     props = json.dumps(additional_properties)
+
+                governed_by = c_client.get_related_elements(guid,'GovernedBy')
+                if type(governed_by) is list:
+                    for gov in governed_by:
+                        rel_guid = gov['relatedElement']['elementHeader']['guid']
+                        rel_title = gov['relatedElement']['properties'].get('title','---')
+                        certified_partner= f"{rel_title}: \n"
+                        certified = c_client.get_related_elements(rel_guid, "Certification")
+                        if type(certified) is list:
+                           for rel_elem in certified:
+                                p_name = rel_elem['relatedElement']['properties']['name']
+                                certified_partner += f"* {p_name}\n"
+                else:
+                    certified_partner = "---"
+
+
                 table.add_row(
                     name, description, classification, qualified_name, identifier, phase, health, status, start,
-                    end, '---')
+                    end, certified_partner)
 
         p_client.close_session()
         return table

examples/widgets/ops/monitor_engine_activity.py

@@ -103,9 +103,20 @@ def display_engine_activity(server: str, url: str, user: str, user_pass: str, pa
                 else:
                     action_status = f"[red]{action['actionStatus']}"
 
-                target = action.get("actionTargetElements", "Empty")
-                if type(target) is list:
-                    target_element = json.dumps(target[0]["targetElement"]["elementProperties"]["propertiesAsStrings"])
+                targets = action.get("actionTargetElements", "Empty")
+                if type(targets) is list:
+                    tgt_tab = Table()
+                    tgt_tab.add_column('name')
+                    tgt_tab.add_column('guid', no_wrap=True)
+                    tgt_tab.add_column('type_name')
+                    targets_md = ""
+                    for target in targets:
+                        t_name = target['actionTargetName']
+                        t_guid = target['actionTargetGUID']
+                        t_type = target['targetElement']['type']['typeName']
+                        tgt_tab.add_row(t_name, t_guid, t_type)
+                    # target_element = json.dumps(target[0]["targetElement"]["elementProperties"]["propertiesAsStrings"])
+                    target_element = tgt_tab
                 else:
                     target_element = " "
 

pyegeria/__init__.py

@@ -11,8 +11,9 @@ the server platform and servers.
 
 """
 
-from ._globals import (is_debug, disable_ssl_warnings, max_paging_size, TEMPLATE_GUIDS, INTEGRATION_GUIDS
-                       )
+from ._globals import (is_debug, disable_ssl_warnings, max_paging_size, TEMPLATE_GUIDS, INTEGRATION_GUIDS,
+                       default_time_out
+                      )
 
 if disable_ssl_warnings:
     from urllib3.exceptions import InsecureRequestWarning
@@ -47,6 +48,7 @@ from .runtime_manager_omvs import RuntimeManager
 from .action_author_omvs import GovernanceAuthor
 from .glossary_manager_omvs import GlossaryManager
 from .create_tech_guid_lists import build_global_guid_lists
+from .classification_manager_omvs import ClassificationManager
 
 
 #

pyegeria/_globals.py

@@ -13,6 +13,7 @@ is_debug = False
 disable_ssl_warnings = True
 enable_ssl_check = False
 max_paging_size = 500
+default_time_out = 30
 
 comment_types = (
     "ANSWER",

pyegeria/asset_catalog_omvs.py

@@ -9,16 +9,15 @@ Copyright Contributors to the ODPi Egeria project.
 
 """
 import asyncio
-from datetime import datetime
 import json
 
 from httpx import Response
 
-from pyegeria import Client, max_paging_size, body_slimmer, TEMPLATE_GUIDS, INTEGRATION_GUIDS
+from pyegeria import Client, max_paging_size, body_slimmer, TEMPLATE_GUIDS
 from pyegeria._exceptions import (
     InvalidParameterException,
 )
-from ._validators import validate_name, validate_guid, validate_search_string
+from ._validators import validate_search_string
 
 
 class AssetCatalog(Client):
@@ -34,9 +33,6 @@ class AssetCatalog(Client):
             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
-        verify_flag: bool
-            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
-            Defaults to False.
 
     """
 
@@ -46,12 +42,10 @@ class AssetCatalog(Client):
             platform_url: str,
             user_id: str,
             user_pwd: str = None,
-            verify_flag: bool = False,
     ):
-        Client.__init__(self, server_name, platform_url, user_id, user_pwd, verify_flag)
+        Client.__init__(self, server_name, platform_url, user_id, user_pwd)
         self.cur_command_root = f"{platform_url}/servers/"
 
-
     async def _async_create_element_from_template(self, body: dict, server: str = None) -> str:
         """ Create a new metadata element from a template.  Async version.
              Parameters
@@ -304,9 +298,9 @@ class AssetCatalog(Client):
     #
 
     async def _async_find_assets_in_domain(self, search_string: str, start_from: int = 0,
-                                          page_size: int = max_paging_size, starts_with: bool = True,
-                                          ends_with: bool = False, ignore_case: bool = True,
-                                          server: str =  None, time_out:int = 60) -> list | str:
+                                           page_size: int = max_paging_size, starts_with: bool = True,
+                                           ends_with: bool = False, ignore_case: bool = True,
+                                           server: str = None, time_out: int = 60) -> list | str:
         """ Retrieve the list of engine action metadata elements that contain the search string. Async Version.
         Parameters
         ----------
@@ -366,9 +360,9 @@ class AssetCatalog(Client):
         return response.json().get("searchMatches", "no assets found")
 
     def find_assets_in_domain(self, search_string: str, start_from: int = 0,
-                                          page_size: int = max_paging_size, starts_with: bool = True,
-                                          ends_with: bool = False, ignore_case: bool = True,
-                                          server: str =  None, time_out:int = 60) -> list | str:
+                              page_size: int = max_paging_size, starts_with: bool = True,
+                              ends_with: bool = False, ignore_case: bool = True,
+                              server: str = None, time_out: int = 60) -> list | str:
         """ Retrieve the list of engine action metadata elements that contain the search string. Async Version.
         Parameters
         ----------
@@ -411,14 +405,13 @@ class AssetCatalog(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_find_assets_in_domain(search_string,  start_from,page_size,
+            self._async_find_assets_in_domain(search_string, start_from, page_size,
                                               starts_with, ends_with, ignore_case, server, time_out)
         )
         return response
 
-
-    async def _async_get_asset_graph(self, asset_guid:str, server: str = None, start_from: int = 0,
-                                     page_size: int = max_paging_size) -> str| dict:
+    async def _async_get_asset_graph(self, asset_guid: str, server: str = None, start_from: int = 0,
+                                     page_size: int = max_paging_size) -> str | dict:
         """ Return all the elements that are anchored to an asset plus relationships between these elements and to
             other elements. Async Version.
            Parameters
@@ -456,7 +449,7 @@ class AssetCatalog(Client):
         return response.json().get("assetGraph", "no asset found")
 
     def get_asset_graph(self, asset_guid: str, server: str = None, start_from: int = 0,
-                               page_size: int = max_paging_size) -> str | dict:
+                        page_size: int = max_paging_size) -> str | dict:
         """ Return all the elements that are anchored to an asset plus relationships between these elements and to
             other elements.
            Parameters
@@ -488,13 +481,14 @@ class AssetCatalog(Client):
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_asset_graph(asset_guid, server,start_from, page_size)
+            self._async_get_asset_graph(asset_guid, server, start_from, page_size)
         )
         return response
 
-    async def _async_get_assets_by_metadata_collection_id(self, metadata_collection_id:str, type_name: str = None,
+    async def _async_get_assets_by_metadata_collection_id(self, metadata_collection_id: str, type_name: str = None,
                                                           effective_time: str = None, server: str = None,
-                                                          start_from: int = 0, page_size: int = max_paging_size) -> str| list:
+                                                          start_from: int = 0,
+                                                          page_size: int = max_paging_size) -> str | list:
         """ Return a list of assets that come from the requested metadata collection. Can optionally
             specify an type name as a filter and an effective time. Async Version.
 
@@ -545,9 +539,9 @@ class AssetCatalog(Client):
         return response.json().get("assets", "no assets found")
 
     def get_assets_by_metadata_collection_id(self, metadata_collection_id: str, type_name: str = None,
-                                                    effective_time: str = None, server: str = None,
-                                                    start_from: int = 0,
-                                                    page_size: int = max_paging_size) -> str | list:
+                                             effective_time: str = None, server: str = None,
+                                             start_from: int = 0,
+                                             page_size: int = max_paging_size) -> str | list:
         """ Return a list of assets that come from the requested metadata collection. Can optionally
             specify an type name as a filter and an effective time. Async Version.
 
@@ -587,12 +581,12 @@ class AssetCatalog(Client):
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
             self._async_get_assets_by_metadata_collection_id(metadata_collection_id, type_name,
-                                                             effective_time,server,start_from,
+                                                             effective_time, server, start_from,
                                                              page_size)
         )
         return response
 
-    async def _async_get_asset_catalog_types(self, server: str = None) -> str| dict:
+    async def _async_get_asset_catalog_types(self, server: str = None) -> str | dict:
         """ Return all the elements that are anchored to an asset plus relationships between these elements and to
             other elements. Async Version.
            Parameters
@@ -627,7 +621,7 @@ class AssetCatalog(Client):
 
         response = await self._async_make_request("GET", url)
 
-        return response.json().get('types',"No assets found")
+        return response.json().get('types', "No assets found")
 
     def get_asset_catalog_types(self, server: str = None) -> str | dict:
         """ Return all the elements that are anchored to an asset plus relationships between these elements and to
@@ -665,6 +659,7 @@ class AssetCatalog(Client):
         )
         return response
 
+
 if __name__ == "__main__":
     p = AssetCatalog("active-metadata-store", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
     response = p.get_assets_by_metadata_collection_id()