pyegeria 0.6.4__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")
@@ -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.dist-info → pyegeria-0.6.5.dist-info}/METADATA

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

{pyegeria-0.6.4.dist-info → pyegeria-0.6.5.dist-info}/RECORD

@@ -4,11 +4,13 @@ examples/widgets/cat/README.md,sha256=-aaAnIT2fcfU63vajgB-RzQk4l4yFdhkyVfSaTPiqR
 examples/widgets/cat/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 examples/widgets/cat/get_asset_graph.py,sha256=Q23n_svJBii58hgaMPLpliN8wqKl4yhnhCCk2IU2nvM,11168
 examples/widgets/cat/get_collection.py,sha256=DBZ5-XkoYsz4WmMSPz0Ao0wz3DlAUQve89KI26-44nc,4613
+examples/widgets/cat/get_project_structure.py,sha256=IA5PtZn6IzhVF0J6vzCasKPqu6Y1dY7CHkzo6VvqedA,4962
 examples/widgets/cat/get_tech_type_elements.py,sha256=SvnDWfBIA1NzpkKZj4-ZapIeM2SEhe5jJt7rTkvTzaA,6129
 examples/widgets/cat/get_tech_type_template.py,sha256=gMFVcgCIm09GQu1Vsc5ZUVH9XLhItAG1eVGZJrcnHeQ,6174
 examples/widgets/cat/list_assets.py,sha256=imVun2GB3zoEjaQxKJVGcalI7yZv5Dg_ksb7tYCIVLE,6476
+examples/widgets/cat/list_cert_types.py,sha256=6FmVoNVKz6TRaxQ0XR8IySRCvwKV03wOoY_bSwLgFdU,7005
 examples/widgets/cat/list_glossary.py,sha256=zljSzVKYysFZVmVhHJt0fYFDmAG9azIphOs4MOIfA7g,5395
-examples/widgets/cat/list_projects.py,sha256=pFXjP_OjfLqR0hQuJl90u8Y7T0Z0YdVZazrcUwPVGaE,6510
+examples/widgets/cat/list_projects.py,sha256=jP6HoVqGi-w4R1itgdAW1zamPLsgkvjvh8reRj0v10Q,7432
 examples/widgets/cat/list_tech_types.py,sha256=20T4v6L5qeebSsaL1nGkFMDAIsy2W3A3SMm1RcgFoh0,4609
 examples/widgets/cat/list_todos.py,sha256=wD9HevGcc4G_bxV25VUz1rRssdZHE33mF5zmJ6Lprt8,5522
 examples/widgets/cli/__init__.py,sha256=6d_R0KZBNnJy9EBz9J2xvGFlx-3j_ZPqPCxKgdvYeDQ,291
@@ -76,8 +78,8 @@ pyegeria/runtime_manager_omvs.py,sha256=oSVFeG_yBGXIvQR0EClLZqTZ6C5z5ReZzwm8cce8
 pyegeria/server_operations.py,sha256=ZX7FlJRrAC7RK4bq4wHWepEsYbbWlqkUZdsJrTplVVU,16534
 pyegeria/utils.py,sha256=pkVmS3RrbjaS9yz7FtOCwaOfV5FMqz-__Rt5koCnd9c,5374
 pyegeria/valid_metadata_omvs.py,sha256=aisdRodIwJSkyArAzfm_sEnBELh69xE8k4Nea-vHu8M,36745
-pyegeria-0.6.4.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.6.4.dist-info/METADATA,sha256=0MjuQgAF2P8S0TonF0zw01gDKvQT9NAG1M_gx37rfZQ,2774
-pyegeria-0.6.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-0.6.4.dist-info/entry_points.txt,sha256=Up_rwJL9Rnmsp4Lp5433ctUMb6qR9uTQc7e5tVkcXFg,2599
-pyegeria-0.6.4.dist-info/RECORD,,
+pyegeria-0.6.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-0.6.5.dist-info/METADATA,sha256=itmo7_30ZJcfzitQ9CAgp6j-j4AmiZ8OY9za5IGbf-4,2774
+pyegeria-0.6.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-0.6.5.dist-info/entry_points.txt,sha256=JZ24qmAz953R1Rw2l5PpW6O_IyIuHBz-ypZvl2mvccE,2657
+pyegeria-0.6.5.dist-info/RECORD,,

{pyegeria-0.6.4.dist-info → pyegeria-0.6.5.dist-info}/entry_points.txt

@@ -13,6 +13,7 @@ hey_egeria=examples.widgets.cli.egeria:cli
 list_asset_types=examples.widgets.tech.list_asset_types:main
 list_assets=examples.widgets.cat.list_assets:main
 list_catalog_targets=examples.widgets.ops.list_catalog_targets:main
+list_cert_types=examples.widgets.cat.list_cert_types:main
 list_engine_activity=examples.widgets.ops.monitor_engine_activity:main_paging
 list_glossary=examples.widgets.cat.list_glossary:main
 list_gov_eng_status=examples.widgets.ops.monitor_gov_eng_status:main_paging