pyegeria 0.7.19__tar.gz → 0.7.21__tar.gz

{pyegeria-0.7.19 → pyegeria-0.7.21}/PKG-INFO

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

{pyegeria-0.7.19 → pyegeria-0.7.21}/examples/widgets/cat/list_todos.py

@@ -96,7 +96,7 @@ def display_to_dos(search_string: str, status_filter: str, server: str, url: str
                 status = props.get("toDoStatus")
 
                 assigned_out = ''
-                assigned_actors = item["assignedActors"]
+                assigned_actors = item.get("assignedActors",'---')
                 if type(assigned_actors) is list:
                     assigned_md = ''
                     for actor in assigned_actors:

pyegeria-0.7.21/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.19 → pyegeria-0.7.21}/examples/widgets/cli/egeria.py

@@ -26,9 +26,10 @@ from examples.widgets.cat.list_tech_types import display_tech_types
 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
@@ -522,6 +523,14 @@ def show_todos(ctx, search_string, status):
     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)
+
 
 #
 #  Catalog User: Tell

{pyegeria-0.7.19 → pyegeria-0.7.21}/examples/widgets/cli/egeria_cat.py

@@ -25,6 +25,7 @@ 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
@@ -249,6 +250,14 @@ def show_todos(ctx, search_string, status):
     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.19 → pyegeria-0.7.21}/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

{pyegeria-0.7.19 → pyegeria-0.7.21}/examples/widgets/my/monitor_open_todos.py

@@ -95,7 +95,7 @@ def display_todos(server: str , url: str, user: str, user_pass:str,
                 priority = str(props.get("priority", " "))
                 due = props.get("dueTime", " ")
                 completed = props.get("completionTime", " ")
-                status = props.get("status")
+                status = props.get("todoStatus")
                 # assigned_actors = item["assignedActors"]
                 # sponsor = assigned_actors[0].get("uniqueName", " ")
                 sponsor = "erinoverview"

pyegeria-0.7.21/examples/widgets/my/todo_actions.py

@@ -0,0 +1,188 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Execute ToDo actions.
+
+"""
+import os
+import time
+
+import click
+
+# from ops_config import Config, pass_config
+from pyegeria import MyProfile
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    print_exception_response,
+)
+
+erins_guid = "a588fb08-ae09-4415-bd5d-991882ceacba"
+peter_guid = "a187bc48-8154-491f-97b4-a2f3c3f1a00e"
+tanya_guid = "26ec1614-bede-4b25-a2a3-f8ed26db3aaa"
+
+ERIA_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_INTEGRATION_DAEMON_URL = os.environ.get('EGERIA_INTEGRATION_DAEMON_URL', 'https://localhost:9443')
+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')
+
+
+@click.command('create-todo')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_USER, help='Egeria user')
+@click.option('--password', default=EGERIA_USER_PASSWORD, help='Egeria user password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+@click.option('--name', prompt='Todo Name', help='Name of Todo', required=True)
+@click.option('--description', prompt='Description', help='Brief description of To Do item', required=True)
+@click.option('--type', prompt='Todo Type', help='Type of Todo', required=True, default='forMe')
+@click.option('--priority', prompt='Todo Priority', type=int, help='Priority of Todo', required=True, default=0)
+@click.option('--due', prompt='Due Date', help='Due date of Todo (yyyy-mm-dd)', required=True)
+@click.option('--assigned-to', prompt='Assigned to', help='Party the Todo is assigned to', required=True,
+              default=peter_guid)
+def create_todo(server, url, userid, password, timeout, name, description, type, priority, due, assigned_to):
+    """Create a new ToDo item"""
+    m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        body = {
+            "properties": {
+                "class": "ToDoProperties",
+                "qualifiedName": f"{name}-{time.asctime()}",
+                "name": name,
+                "description": description,
+                "toDoType": type,
+                "priority": priority,
+                "dueTime": due,
+                "status": "OPEN"
+            },
+            "assignToActorGUID": assigned_to
+        }
+
+        resp = m_client.create_to_do(body)
+        # if type(resp) is str:
+        click.echo(f"Response was {resp}")
+        # elif type(resp) is dict:
+        #     click.echo(json.dumps(resp), indent = 2)
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command('delete-todo')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_USER, help='Egeria user')
+@click.option('--password', default=EGERIA_USER_PASSWORD, help='Egeria user password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+@click.argument('todo-guid')
+def delete_todo(server, url, userid, password, timeout, todo_guid):
+    """Delete the todo item specified """
+    m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        m_client.delete_to_do(todo_guid)
+
+        click.echo(f"Deleted Todo item {todo_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command('change-todo-status')
+@click.argument('todo-guid')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_USER, help='Egeria user')
+@click.option('--password', default=EGERIA_USER_PASSWORD, help='Egeria user password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+@click.option('--new-status', type=click.Choice(['OPEN', 'IN_PROGRESS', 'WAITING', 'COMPLETE', 'ABANDONED'],
+                                                case_sensitive='False'), help='Enter the new ToDo item status',
+              required=True)
+def change_todo_status(server, url, userid, password, timeout, todo_guid, new_status):
+    """Update a ToDo item status"""
+    m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+
+        body = {
+            "properties": {
+                "class": "ToDoProperties",
+                "toDoStatus": new_status
+            },
+        }
+        m_client.update_to_do(todo_guid, body, is_merge_update=True)
+
+        click.echo(f"Marked todo item {todo_guid} as complete.")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command('mark-todo-complete')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_USER, help='Egeria user')
+@click.option('--password', default=EGERIA_USER_PASSWORD, help='Egeria user password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+@click.argument('todo-guid')
+def mark_todo_complete(server, url, userid, password, timeout, todo_guid):
+    """Mark the specified todo as complete"""
+    try:
+        m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+        token = m_client.create_egeria_bearer_token()
+        body = {
+            "properties": {
+                "class": "ToDoProperties",
+                "completionTime": time.asctime(),
+                "toDoStatus": "COMPLETE"
+            },
+        }
+        m_client.update_to_do(todo_guid, body, is_merge_update=True)
+
+        click.echo(f"Marked todo item {todo_guid} as complete.")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command('reassign-todo')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_USER, help='Egeria user')
+@click.option('--password', default=EGERIA_USER_PASSWORD, help='Egeria user password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+@click.argument('todo-guid')
+@click.argument('new-actor-guid')
+def reassign_todo(server, url, userid, password, timeout, todo_guid, new_actor_guid):
+    """Reassign ToDo item to new actor"""
+    m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+
+        m_client.reassign_to_do(todo_guid, new_actor_guid)
+
+        click.echo(f"Reassigned Todo item {todo_guid} to {new_actor_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()

pyegeria-0.7.21/examples/widgets/ops/engine_actions.py

@@ -0,0 +1,71 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Execute engine actions.
+
+"""
+import os
+
+import click
+
+# from ops_config import Config, pass_config
+from pyegeria import Platform
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    print_exception_response,
+)
+
+GERIA_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_INTEGRATION_DAEMON_URL = os.environ.get('EGERIA_INTEGRATION_DAEMON_URL', 'https://localhost:9443')
+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')
+
+
+@click.command('stop')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_ADMIN_USER, help='Egeria admin user')
+@click.option('--password', default=EGERIA_ADMIN_PASSWORD, help='Egeria admin password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+def stop_daemon(file, server, url, userid, password, timeout):
+    """Stop an engine-host daemon"""
+    p_client = Platform(server, url, userid, password)
+    try:
+        p_client.shutdown_server()
+
+        click.echo(f"Stopped server {server}")
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()
+
+
+@click.command('start')
+@click.option('--server', default=EGERIA_VIEW_SERVER, help='Egeria metadata store to load')
+@click.option('--url', default=EGERIA_VIEW_SERVER_URL, help='URL of Egeria platform to connect to')
+@click.option('--userid', default=EGERIA_ADMIN_USER, help='Egeria admin user')
+@click.option('--password', default=EGERIA_ADMIN_PASSWORD, help='Egeria admin password')
+@click.option('--timeout', default=60, help='Number of seconds to wait')
+def start_daemon(file, server, url, userid, password, timeout):
+    """Start or restart an engine-host from its known configuration """
+    p_client = Platform(server, url, userid, password)
+    try:
+        p_client.activate_server_stored_config()
+
+        click.echo(f"Started server {server}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()