pyegeria 0.6.4__tar.gz → 0.6.6__tar.gz

{pyegeria-0.6.4 → pyegeria-0.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.6.4
+Version: 0.6.6
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

pyegeria-0.6.6/examples/widgets/cat/get_project_structure.py

@@ -0,0 +1,165 @@
+#!/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 rich.markdown import Markdown
+from rich.console import Console
+
+from pyegeria import (ProjectManager, MyProfile, 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, 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(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']
+                # child_props = proj['properties']
+                # for key in child_props.keys():
+                #     child_md += f"* {key}: {child_props[key]}\n"
+                # child_md += f"* GUID: {child_guid}"
+                walk_project_hierarchy(project_client, child_name, t)
+
+        else:
+            return t
+        #     tt= tree.add(f"[bold magenta on black]No projects match {root_project_name}")
+
+            #
+            # branch = tt.add(f"[bold magenta on black]Members", style=style, guide_style=style)
+            # walk_collection_hierarchy(collection_client, member['qualifiedName'], branch),
+
+        # members = project_client.get_member_list(root_project_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)
+        #
+        #
+        #         linked_projects = project_client.get_linked_projects()
+        #         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:
+        console = Console(width=EGERIA_WIDTH)
+        tree = Tree(f"[bold bright green on black]{root}",guide_style="bold bright_blue")
+        p_client = ProjectManager(server_name, platform_url,
+                                     user_id=user)
+
+        token1= p_client.create_egeria_bearer_token(user, user_password)
+
+        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:
+        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()

pyegeria-0.6.6/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()

{pyegeria-0.6.4 → pyegeria-0.6.6}/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")
@@ -112,11 +113,24 @@ def display_project_list(project_name: str, server: str, url: str,
                 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

{pyegeria-0.6.4 → pyegeria-0.6.6}/pyegeria/my_profile_omvs.py

@@ -43,7 +43,8 @@ class MyProfile(Client):
             sync_mode: bool = True
     ):
 
-        Client.__init__(self, server_name, platform_url, user_id=user_id, token=token, async_mode=sync_mode)
+        Client.__init__(self, server_name, platform_url, user_id=user_id, user_pwd=user_pwd,
+                        token=token, async_mode=sync_mode)
         self.my_profile_command_root: str = f"{platform_url}/servers"
 
     #
@@ -818,7 +819,7 @@ class MyProfile(Client):
                                                                   ends_with, ignore_case, start_from, page_size))
         return response
 
-    async def _async_get_to_dos_by_type(self, todo_type: str,  server_name: str = None, status: str = "OPEN",
+    async def _async_get_to_dos_by_type(self, todo_type: str, server_name: str = None, status: str = "OPEN",
                                         start_from: int = 0, page_size: int = 100) -> list | str:
         """ Get To-Do items by type. Async version
             Parameters
@@ -861,9 +862,9 @@ class MyProfile(Client):
                f"{todo_type}?startFrom={start_from}&pageSize={page_size}")
 
         response = await self._async_make_request("POST", url, body)
-        return response.json().get("elements","No ToDos found")
+        return response.json().get("elements", "No ToDos found")
 
-    def get_to_dos_by_type(self, todo_type: str,  server_name: str = None, status: str = "OPEN",
+    def get_to_dos_by_type(self, todo_type: str, server_name: str = None, status: str = "OPEN",
                            start_from: int = 0, page_size: int = 100) -> list | str:
         """ Get To-Do items by type.
             Parameters
@@ -894,7 +895,7 @@ class MyProfile(Client):
             The principle specified by the user_id does not have authorization for the requested action
             """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_get_to_dos_by_type(todo_type,  server_name, status,
+        response = loop.run_until_complete(self._async_get_to_dos_by_type(todo_type, server_name, status,
                                                                           start_from, page_size))
         return response
 

{pyegeria-0.6.4 → pyegeria-0.6.6}/pyegeria/project_manager_omvs.py

@@ -104,7 +104,7 @@ class ProjectManager(Client):
                f"metadata-elements/{parent_guid}/projects?startFrom={start_from}&pageSize={page_size}")
 
         resp = await self._async_make_request("POST", url, body_s)
-        return resp.json()
+        return resp.json().get('elements','No linked projects found')
 
     def get_linked_projects(self, parent_guid: str, project_status: str = None, effective_time: str = None,
                             server_name: str = None, start_from: int = 0, page_size: int = None) -> list | str:

{pyegeria-0.6.4 → pyegeria-0.6.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "0.6.4"
+version = "0.6.6"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -61,6 +61,8 @@ pytest = "^8.2.2"
     get_tech_type_template = "examples.widgets.cat.get_tech_type_template:main"
     list_projects = "examples.widgets.cat.list_projects:main"
     list_todos = "examples.widgets.cat.list_todos:main"
+    list_cert_types = "examples.widgets.cat.list_cert_types:main"
+
 
     monitor_asset_events = "examples.widgets.ops.monitor_asset_events:main"
     monitor_coco_status = "examples.widgets.ops.monitor_coco_status:main"