pyegeria 0.7.18__tar.gz → 0.7.20__tar.gz

{pyegeria-0.7.18 → pyegeria-0.7.20}/PKG-INFO

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

pyegeria-0.7.20/examples/widgets/cat/get_project_dependencies.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for project dependencies - provide the root and we display the dependency tree
+
+"""
+
+import argparse
+import os
+
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+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_dependency_viewer(root: str, server_name: str, platform_url: str, user: str, user_password: str,
+                             jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH, timeout: int = 30):
+    """ 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.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]{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_dependency_viewer(root_project, server, url, userid, user_pass)
+    except (KeyboardInterrupt):
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cat/get_project_structure.py

@@ -88,6 +88,9 @@ def project_structure_viewer(root: str, server_name: str, platform_url: str, use
                 child_md = ""
                 child_guid = proj['elementHeader']['guid']
                 child_name = proj['properties']['name']
+                relationship = proj['relatedElement']['relationshipHeader']['type']['typeName']
+                if relationship != 'ProjectHierarchy':
+                    continue
                 walk_project_hierarchy(project_client, child_name, t)
 
         else:

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cat/list_todos.py

@@ -15,6 +15,7 @@ import time
 
 from rich import box
 from rich.console import Console
+from rich.markdown import Markdown
 from rich.prompt import Prompt
 from rich.table import Table
 
@@ -40,7 +41,7 @@ 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 display_to_dos(search_string: str, server: str, url: str, username: str, user_pass:str,
+def display_to_dos(search_string: str, status_filter: str, server: str, url: str, username: str, user_pass:str,
                    jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH):
 
     m_client = MyProfile(server, url, user_id=username)
@@ -60,15 +61,16 @@ def display_to_dos(search_string: str, server: str, url: str, username: str, use
 
         table.add_column("Name")
         table.add_column("Type Name")
-
+        table.add_column("GUID", no_wrap=True)
         table.add_column("Created")
         table.add_column("Priority")
         table.add_column("Due")
         table.add_column("Completion")
         table.add_column("Status")
         table.add_column("Sponsor")
+        table.add_column("Assigned")
 
-        todo_items = m_client.find_to_do(search_string)
+        todo_items = m_client.find_to_do(search_string,status = status_filter)
 
         if type(todo_items) is str:
             name = " "
@@ -80,18 +82,27 @@ def display_to_dos(search_string: str, server: str, url: str, username: str, use
 
             status = " "
             sponsor = " "
+            assigned_out = ''
         else:
             for item in todo_items:
+                guid = item['elementHeader']['guid']
                 props = item["properties"]
                 name = props["name"]
                 type_name = props.get("toDoType", " ")
-                created = props.get("creationTime", " ")
+                created = props.get("creationTime", " ")[:-19]
                 priority = str(props.get("priority", " "))
-                due = props.get("dueTime", " ")
-                completed = props.get("completionTime", " ")
-                status = props.get("status")
-                # assigned_actors = item["assignedActors"]
-                # sponsor = assigned_actors[0].get("uniqueName", " ")
+                due = props.get("dueTime", "          ")[:-19]
+                completed = props.get("completionTime", "           ")[:-10]
+                status = props.get("toDoStatus")
+
+                assigned_out = ''
+                assigned_actors = item["assignedActors"]
+                if type(assigned_actors) is list:
+                    assigned_md = ''
+                    for actor in assigned_actors:
+                        assigned_md += f"* {actor['uniqueName'].split(',')[0]}\n"
+                    assigned_out = Markdown(assigned_md)
+
                 sponsor = "erinoverview"
                 if status in ("WAITING", "OPEN"):
                     status = f"[yellow]{status}"
@@ -101,7 +112,7 @@ def display_to_dos(search_string: str, server: str, url: str, username: str, use
                     status = f"[red]{status}"
 
                 table.add_row(
-                    name, type_name, created, priority, due, completed, status, sponsor
+                    name, type_name, guid, created, priority, due, completed, status, sponsor, assigned_out
                 )
 
         m_client.close_session()
@@ -140,8 +151,10 @@ def main():
     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 the ToDo you are searching for:", default="*")
-        display_to_dos(search_string, server, url, userid, user_pass)
+        search_string = Prompt.ask("Enter the ToDo you are searching for", default="*")
+        status_filter = Prompt.ask("Enter an optional status filter ['OPEN','IN_PROGRESS','WAITING','COMPLETE',"
+                                   "'ABANDONED', 'None']", default=None)
+        display_to_dos(search_string, status_filter,server, url, userid, user_pass)
     except KeyboardInterrupt:
         pass
 

pyegeria-0.7.20/examples/widgets/cat/list_user_ids.py

@@ -0,0 +1,119 @@
+"""This creates a templates guid file from the core metadata archive"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+   ClassificationManager
+)
+
+
+console = Console()
+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 list_user_ids(server: str,
+                       url: str, username: str, password: str, jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH
+):
+
+    c_client = ClassificationManager(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+    elements = c_client.get_elements('UserIdentity')
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Metadata Elements for: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            title=f"Elements for Open Metadata Type: 'User Identities' ",
+            expand=True,
+            # width=500
+        )
+
+        table.add_column("Qualified Name")
+        table.add_column("Created")
+        table.add_column("GUID", width = 38,no_wrap=True)
+        table.add_column("UserId")
+
+
+        if type(elements) is list:
+            for element in elements:
+                header = element['elementHeader']
+                el_q_name = element['properties'].get('qualifiedName',"---")
+                el_create_time = header['versions']['createTime'][:-10]
+                el_guid = header['guid']
+                el_user_id = element['properties'].get('userId',"---")
+
+                table.add_row(el_q_name,  el_create_time, el_guid, el_user_id)
+
+            return table
+        else:
+            print("No instances found")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        print("Perhaps the type name isn't known")
+    finally:
+        c_client.close_session()
+
+
+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="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
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        list_user_ids(server, url, userid, password)
+    except(KeyboardInterrupt):
+        pass
+
+
+if __name__ == "__main__":
+    main()
+
+
+

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cli/egeria.py

@@ -13,6 +13,7 @@ import click
 from trogon import tui
 
 from examples.widgets.cat.get_project_structure import project_structure_viewer
+from examples.widgets.cat.get_project_dependencies import project_dependency_viewer
 from examples.widgets.cat.list_cert_types import display_certifications
 from examples.widgets.cat.get_asset_graph import asset_viewer
 from examples.widgets.cat.get_collection import collection_viewer
@@ -22,12 +23,13 @@ from examples.widgets.cat.list_assets import display_assets
 from examples.widgets.cat.list_glossary import display_glossary_terms
 from examples.widgets.cat.list_projects import display_project_list
 from examples.widgets.cat.list_tech_types import display_tech_types
-from examples.widgets.cat.list_todos import display_to_dos
+from examples.widgets.cat.list_todos import display_to_dos as list_todos
 from examples.widgets.cli.ops_config import Config
 from examples.widgets.cat.list_relationships import list_relationships
+from examples.widgets.cat.list_user_ids import list_user_ids
 
-from examples.widgets.ops.engine_actions import start_server as start_engine_host, \
-    stop_server as stop_engine_host
+from examples.widgets.ops.engine_actions import start_daemon as start_engine_host, \
+    stop_daemon as stop_engine_host
 from examples.widgets.ops.integration_daemon_actions import (add_catalog_target, remove_catalog_target,
                                                              update_catalog_target, stop_server, start_server)
 from examples.widgets.ops.list_catalog_targets import display_catalog_targets
@@ -415,11 +417,23 @@ def show_certification_types(ctx, search_string):
               help="Enter the root project to start from")
 @click.pass_context
 def show_project_structure(ctx, project):
-    """Show the structure of the project starting from a root project"""
+    """Show the organization structure of the project starting from a root project"""
     c = ctx.obj
     project_structure_viewer(project, c.view_server, c.view_server_url, c.userid,
                            c.password, c.jupyter, c.width, c.timeout)
 
+@show.command('project-dependencies')
+@click.option('--project', default = 'Clinical Trials Management',
+              help="Enter the root project to start from")
+@click.pass_context
+def show_project_dependencies(ctx, project):
+    """Show the dependencies of a project starting from a root project"""
+    c = ctx.obj
+    project_dependency_viewer(project, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.jupyter, c.width, c.timeout)
+
+
+
 @show.command('relationships')
 @click.option('--relationship', default = 'Certification',
               help="Relationship type name to search for.")
@@ -500,11 +514,21 @@ def show_projects(ctx, search_string):
 @show.command('to-dos')
 @click.option('--search-string', default='*',
               help='View the list of To-Do items')
+@click.option('--status', type=click.Choice(['OPEN','IN_PROGRESS','WAITING','COMPLETE', 'ABANDONED', 'None'],
+               case_sensitive='False'), help = 'Enter an optional status filter', required=False, default=None)
+@click.pass_context
+def show_todos(ctx, search_string, status):
+    """Display a tree graph of information about an asset """
+    c = ctx.obj
+    list_todos(search_string, status, c.view_server, c.view_server_url, c.userid,
+                   c.password, c.jupyter, c.width)
+
+@show.command('user-ids')
 @click.pass_context
-def show_todos(ctx, search_string):
+def show_todos(ctx):
     """Display a tree graph of information about an asset """
     c = ctx.obj
-    display_to_dos(search_string, c.view_server, c.view_server_url, c.userid,
+    list_user_ids( c.view_server, c.view_server_url, c.userid,
                    c.password, c.jupyter, c.width)
 
 

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cli/egeria_cat.py

@@ -20,10 +20,12 @@ from examples.widgets.cat.list_assets import display_assets
 from examples.widgets.cat.list_glossary import display_glossary_terms
 from examples.widgets.cat.list_tech_types import display_tech_types
 from examples.widgets.cat.list_projects import display_project_list
-from examples.widgets.cat.list_todos import display_to_dos
+from examples.widgets.cat.list_todos import display_to_dos as list_todos
 from examples.widgets.cat.get_project_structure import project_structure_viewer
+from examples.widgets.cat.get_project_dependencies import project_dependency_viewer
 from examples.widgets.cat.list_cert_types import display_certifications
 from examples.widgets.cat.list_relationships import list_relationships
+from examples.widgets.cat.list_user_ids import list_user_ids
 
 # from pyegeria import ServerOps
 from examples.widgets.cli.ops_config import Config
@@ -207,11 +209,23 @@ def show_certification_types(ctx, search_string):
               help="Enter the root project to start from")
 @click.pass_context
 def show_project_structure(ctx, project):
-    """Show the structure of the project starting from a root project"""
+    """Show the organization structure of the project starting from a root project"""
     c = ctx.obj
     project_structure_viewer(project, c.view_server, c.view_server_url, c.userid,
                            c.password, c.jupyter, c.width, c.timeout)
 
+@show.command('project-dependencies')
+@click.option('--project', default = 'Clinical Trials Management',
+              help="Enter the root project to start from")
+@click.pass_context
+def show_project_dependencies(ctx, project):
+    """Show the dependencies of a project starting from a root project"""
+    c = ctx.obj
+    project_dependency_viewer(project, c.view_server, c.view_server_url, c.userid,
+                           c.password, c.jupyter, c.width, c.timeout)
+
+
+
 @show.command('relationships')
 @click.option('--relationship', default = 'Certification',
               help="Relationship type name to search for.")
@@ -227,12 +241,22 @@ def show_relationships(ctx, relationship):
 @show.command('to-dos')
 @click.option('--search-string', default='*',
               help='View the list of To-Do items')
+@click.option('--status', type=click.Choice(['OPEN','IN_PROGRESS','WAITING','COMPLETE', 'ABANDONED', 'None'],
+               case_sensitive='False'), help = 'Enter an optional status filter', required=False, default=None)
 @click.pass_context
-def show_todos(ctx, search_string):
+def show_todos(ctx, search_string, status):
     """Display a tree graph of information about an asset """
     c = ctx.obj
-    display_to_dos(search_string, c.view_server, c.view_server_url, c.userid,
-                      c.password, c.jupyter, c.width)
+    list_todos(search_string, status, c.view_server, c.view_server_url, c.userid,
+                   c.password, c.jupyter, c.width)
+
+@show.command('user-ids')
+@click.pass_context
+def show_todos(ctx):
+    """Display a tree graph of information about an asset """
+    c = ctx.obj
+    list_user_ids( c.view_server, c.view_server_url, c.userid,
+                   c.password, c.jupyter, c.width)
 
 #
 #  Tell

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cli/egeria_my.py

@@ -12,13 +12,15 @@ This is an emerging capability based on the **click** package. Feedback welcome!
 import click
 from trogon import tui
 
+from examples.widgets.cat import list_todos
 from examples.widgets.cli.ops_config import Config
 
 from examples.widgets.my.monitor_open_todos import display_todos
 from examples.widgets.my.monitor_my_todos import display_my_todos
 from examples.widgets.my.list_my_profile import display_my_profile
 from examples.widgets.my.list_my_roles import display_my_roles
-
+from examples.widgets.my.todo_actions import create_todo, delete_todo, change_todo_status, mark_todo_complete, \
+    reassign_todo
 
 
 # class Config(object):
@@ -148,6 +150,11 @@ def show_open_todos(ctx):
 def tell(ctx):
     """Perform actions an Egeria Objects"""
     pass
+tell.add_command(create_todo)
+tell.add_command(delete_todo)
+tell.add_command(change_todo_status)
+tell.add_command(mark_todo_complete)
+tell.add_command(reassign_todo)
 
 
 if __name__ == '__main__':

{pyegeria-0.7.18 → pyegeria-0.7.20}/examples/widgets/cli/egeria_ops.py

@@ -14,8 +14,8 @@ from trogon import tui
 
 # from pyegeria import ServerOps
 from examples.widgets.cli.ops_config import Config
-from examples.widgets.ops.engine_actions import start_server as start_engine_host, \
-    stop_server as stop_engine_host
+from examples.widgets.ops.engine_actions import start_daemon as start_engine_host, \
+    stop_daemon as stop_engine_host
 from examples.widgets.ops.integration_daemon_actions import (add_catalog_target, remove_catalog_target,
                                                              update_catalog_target, stop_server, start_server)
 from examples.widgets.ops.list_catalog_targets import display_catalog_targets