pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/commands/my/todo_actions.py

@@ -0,0 +1,242 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Execute ToDo actions.
+
+"""
+import os
+import time
+from datetime import datetime
+
+import click
+
+from pyegeria import MyProfile
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    print_exception_response,
+)
+
+erins_guid = "dcfd7e32-8074-4cdf-bdc5-9a6f28818a9d"
+peter_guid = "59f0232c-f834-4365-8e06-83695d238d2d"
+tanya_guid = "a987c2d2-c8b6-4882-b344-c47956d2de97"
+
+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_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 view server to use.")
+@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", help="Name of Todo", required=True)
+@click.option(
+    "--description",
+    help="Brief description of To Do item",
+    required=True,
+)
+@click.option("--type", help="Type of Todo", required=True, default="forMe")
+@click.option(
+    "--priority",
+    type=int,
+    help="Priority of Todo",
+    required=True,
+    default=0,
+)
+@click.option(
+    "--due",
+    help="Due date of Todo (yyyy-mm-dd)",
+    default=datetime.now().strftime("%Y-%m-%d"),
+    required=True,
+)
+@click.option(
+    "--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)
+    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)
+    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)
+    m_client.create_egeria_bearer_token()
+    try:
+        body = {"class": "ToDoProperties", "toDoStatus": new_status}
+
+        m_client.update_to_do(todo_guid, body, is_merge_update=True)
+
+        click.echo(f"Changed todo item {todo_guid} status to {new_status}.")
+
+    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"""
+    m_client = MyProfile(server, url, user_id=userid, user_pwd=password)
+    try:
+        m_client.create_egeria_bearer_token()
+        body = {
+            "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)
+    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/commands/ops/README.md

@@ -0,0 +1,24 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+# Operational
+
+These widgets display different kinds of information useful to monitor the status of different elements of an Egeria deployment.
+Widgets will continue to be added over time to cover more facets of catalog use.
+
+* get_eng_action_status.py - lists assets containing the user provided search string in the display name or qualified name. Search string must be a minimum of three characters.
+* get_tech_type_elements.py - shows a tree view for the details of a supported technology type.
+* get_tech_type_template.py - shows a tree view of the template associated with a supported technology type.
+* view_coco_status.py - provides a tree view of a collection with all nested collections and items within the collection.
+* view_eng_action_status.py - provides a live view of the status of engine actions.
+* view_gov_eng_status.py - provides a live view of a governance engine status.
+* view_integ_daemeon_status.py - provides a live view of an integration daemon status.
+* view_platform_status.py - provides a live status view of the known servers on known platforms.
+* view_server_list.py - provides a more detailed live status view of the servers on a single platform.
+* view_server_status.py - provides a minimal live status view of the servers on a single platform.
+* view_asset_changes.py - experiment in progress
+* view_asset_events.py - experiment in progress
+
+----
+License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
+Copyright Contributors to the Egeria project.

pyegeria/commands/ops/__init__.py

@@ -0,0 +1,22 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+"""
+#
+# from .monitor_integ_daemon_status import display_integration_daemon_status
+# from .monitor_gov_eng_status import display_gov_eng_status
+# from .monitor_platform_status import display_status as display_platform_status
+# from .monitor_server_status import display_status as display_server_status
+# from .monitor_engine_activity_c import display_engine_activity_c
+
+# import monitor_server_status
+# import monitor_server_list
+# import monitor_integ_daemon_status
+# import monitor_platform_status
+# import monitor_engine_activity
+# import refresh_integration_daemon
+# import restart_integration_daemon
+# import integration_daemon_actions
+# import list_catalog_targets

pyegeria/commands/ops/gov_server_actions.py

@@ -0,0 +1,177 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This script restarts an integration daemon.
+
+"""
+
+import os
+from rich import print, print_json
+from rich.console import Console
+
+import click
+from pyegeria import EgeriaTech, AutomatedCuration, INTEGRATION_GUIDS
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+
+
+@click.command("add-target")
+@click.argument("integration-connector")
+@click.argument("metadata-element-guid")
+@click.argument("catalog-target-name")
+@click.pass_context
+def add_catalog_target(
+    ctx,
+    integration_connector: str,
+    metadata_element_guid: str,
+    catalog_target_name: str,
+) -> str:
+    """Add catalog targets to the specified integration connector"""
+    try:
+        if integration_connector not in INTEGRATION_GUIDS.keys():
+            click.echo("Integration connector is not known")
+
+        c = ctx.obj
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
+        token = a_client.create_egeria_bearer_token()
+
+        guid = a_client.add_catalog_target(
+            INTEGRATION_GUIDS[integration_connector],
+            metadata_element_guid,
+            catalog_target_name,
+        )
+
+        click.echo(
+            f"Added catalog target to {integration_connector} with a return guid of {guid}"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+
+
+@click.command("remove-target")
+@click.argument("relationship-guid")
+@click.pass_context
+def remove_catalog_target(ctx, relationship_guid: str):
+    """Remove the catalog target specified by the relationship guidr"""
+    try:
+        c = ctx.obj
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
+        token = a_client.create_egeria_bearer_token()
+
+        a_client.remove_catalog_target(relationship_guid)
+
+        click.echo(
+            f"Removed catalog target with relationship guid of {relationship_guid}"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+
+
+@click.command("update-target")
+@click.argument("relationship-guid")
+@click.argument("catalog-target-name")
+@click.pass_context
+def update_catalog_target(ctx, relationship_guid: str, catalog_target_name: str):
+    """Update the catalog target specified by the relationship guid"""
+    try:
+        c = ctx.obj
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
+        token = a_client.create_egeria_bearer_token()
+
+        guid = a_client.update_catalog_target(relationship_guid, catalog_target_name)
+
+        click.echo(
+            f"Update catalog target with relationship guid of  {relationship_guid} to a catalog target name of "
+            f"{catalog_target_name} with a return guid of {guid}"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+
+
+#
+#   This method will be updated based on forthcoming changes on the Egeria server side
+#
+@click.command("refresh")
+@click.option("-engine-host-guid", help="GUID of engine host to refresh.")
+@click.pass_context
+def refresh_gov_eng_config(ctx, engine_host_guid: str):
+    """Start or restart an engine-host from its known configuration"""
+    c = ctx.obj
+    p_client = EgeriaTech(c.view_server, c.view_server_url, c.userid, c.password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        p_client.refresh_gov_eng_config(None, None, c.engine_host)
+
+        click.echo(f"Refreshed server {c.engine_host}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()
+
+
+@click.command("start")
+@click.pass_context
+@click.option("--server", default="simple-metadata-store", help="OMAG Server to start")
+def start_server(ctx, server):
+    """Start or restart an engine-host from its known configuration"""
+    c = ctx.obj
+
+    p_client = EgeriaTech(c.view_server, c.view_server_url, c.userid, c.password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        server_guid = p_client.get_element_guid_by_unique_name(server, "name")
+        p_client.activate_server_with_stored_config(None, server)
+
+        click.echo(f"Started server {server}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()
+
+
+@click.command("stop")
+@click.option("--server", help="OMAG Server to stop")
+# @click.option(
+#     "--view-server", default=EGERIA_VIEW_SERVER, help="View Server to communicate with"
+# )
+# @click.option(
+#     "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+# )
+# @click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
+# @click.option(
+#     "--password",
+#     default="secret",
+#     envvar="EGERIA_PASSWORD",
+#     help="Egeria user password",
+# )
+@click.pass_context
+def stop_server(ctx, server):
+    """Stop an engine-host daemon"""
+    c = ctx.obj
+    p_client = EgeriaTech(c.view_server, c.view_server_url, c.userid, c.password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        p_client.shutdown_server(None, server)
+        click.echo(f"Stopped server {server}")
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()

pyegeria/commands/ops/list_archives.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for archives
+"""
+import argparse
+import json
+import os
+import time, datetime
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+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")
+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")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_archive_list(
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+) -> object:
+    c_client = ClassificationManager(server, url, user_id=username)
+    token = c_client.create_egeria_bearer_token(username, user_pass)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Archive List  @ {time.asctime()}",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Archive list for Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+
+        table.add_column("Name")
+        table.add_column("Description")
+        table.add_column("Path Name")
+
+        # table.add_column("Creator")
+        # table.add_column("Description")
+
+        open_metadata_type_name = None
+        property_value = "omarchive"
+        property_names = ["fileExtension"]
+        archives = c_client.get_elements_by_property_value(
+            property_value, property_names, open_metadata_type_name
+        )
+
+        if type(archives) != list:
+            raise ValueError("--> No archives found")
+        else:
+            sorted_archives = sorted(
+                archives, key=lambda k: k["properties"].get("name", "---")
+            )
+
+            for archive in sorted_archives:
+                name = archive["properties"].get("name", "---")
+                path_name = archive["properties"].get("pathName", "---")
+                description = archive["properties"].get("description", "---")
+                creation_date_epoch = (
+                    int(archive["properties"].get("storeCreateTime", 0)) / 1000
+                )
+                create_date = datetime.datetime.fromtimestamp(creation_date_epoch)
+                creator = "---"
+
+                table.add_row(name, description, path_name)
+
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+        console = Console(
+            record=True, width=width, force_terminal=not jupyter, soft_wrap=True
+        )
+        with console.pager():
+            console.print(generate_table(), soft_wrap=True)
+        if save_output:
+            console.save_html("archives.html")
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
+        if type(e) is str:
+            print(e)
+        else:
+            print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+    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("--save-output", help="Save output to file?")
+    parser.add_argument("--password", help="User Password")
+    # parser.add_argument("--sponsor", help="Name of sponsor to search")
+    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:
+        save_output = args.save_output if args.save_output is not None else False
+        display_archive_list(server, url, userid, user_pass, save_output)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()