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

pyegeria/commands/cli/egeria_login_tui.py

@@ -0,0 +1,313 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A form exemplar for Egeria users to enter data into templates using Textual open source framework
+
+Peter Coldicott
+"""
+
+import os
+from os import system
+import click
+from textual.reactive import Reactive
+
+from textual.app import App, ComposeResult
+from textual.containers import (
+    Container,
+    Vertical,
+    HorizontalScroll,
+    VerticalScroll,
+    ScrollableContainer,
+)
+from textual import on, work
+from textual.screen import ModalScreen, Screen
+from textual.widgets import (
+    Input,
+    Static,
+    Button,
+    RichLog,
+    Label,
+    Tree,
+    Footer,
+    DataTable,
+    Header,
+)
+
+from typing import Any
+
+
+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_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"))
+
+disable_ssl_warnings = True
+
+TITLE = "User Access"
+
+
+class UserInfo(Screen):
+    """A screen to request user access info - required
+    If no information is supplied the access defaults to a set of
+    demo/test values:
+    User: erinoverview
+    Password: Secret
+    Platform URL: https://localhost:9443
+    View Server Name: view-server"""
+
+    BINDINGS = [("d", "toggle_dark", "Toggle dark mode")]
+
+    def __init__(self) -> None:
+        """Initialize the UserInfo Screen variables"""
+        self.app.dark = True
+        self.user = ""
+        self.password = ""
+        self.platformu = ""
+        self.view_server = ""
+        self.tech_type = ""
+        super().__init__()
+
+    def compose(self) -> ComposeResult:
+        self.log("In UserInfo - Compose ")
+        with VerticalScroll(id="user-container"):
+            yield Label("Username: ", classes="uprompt")
+            yield Input("", id="username", classes="uinput")
+        with VerticalScroll(id="pwd-container"):
+            yield Label("Password: ", classes="uprompt")
+            yield Input("", id="password", classes="uinput")
+        with VerticalScroll(id="platform-container"):
+            yield Label("Platform URL: ", classes="uprompt")
+            yield Input("", id="platform_url", classes="uinput")
+        with VerticalScroll(id="view-server-container"):
+            yield Label("View Server Name: ", classes="uprompt")
+            yield Input("", id="view_server", classes="uinput")
+        with HorizontalScroll(id="button-container"):
+            yield Button("Cancel", "warning", id="cancel")
+            yield Button("Submit", "primary", id="submit")
+        yield RichLog()
+        yield Footer()
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark mode."""
+
+        self.app.dark = not self.app.dark
+
+    def on_input_changed(self, event: Input.Changed) -> None:
+        """Detect input changed events and capture input value"""
+
+        try:
+            ivalue = str(event.value)
+        except ValueError:
+            return
+        else:
+            if event.input.id == "username":
+                self.user = ivalue
+            elif event.input.id == "password":
+                self.password = ivalue
+            elif event.input.id == "platform_url":
+                self.platformu = ivalue
+            elif event.input.id == "view_server":
+                self.view_server = ivalue
+        return
+
+    @on(Button.Pressed, "#submit")
+    async def on_submit(self) -> []:
+        """This processes the user input."""
+
+        global EGERIA_USER
+        global EGERIA_USER_PASSWORD
+        global EGERIA_PLATFORM_URL
+        global EGERIA_VIEW_SERVER
+
+        result = [" meow", "woof", "neigh", "hoot"]
+
+        if self.user:
+            result[0] = self.user
+        else:
+            result[0] = "erinoverview"
+        if self.password:
+            result[1] = self.password
+        else:
+            result[1] = "secret"
+        if self.platformu:
+            result[2] = self.platformu
+        else:
+            result[2] = "https://localhost:9443"
+        if self.view_server:
+            result[3] = self.view_server
+        else:
+            result[3] = "view-server"
+
+        # Also store the input in global variables
+
+        EGERIA_USER = result[0]
+        EGERIA_USER_PASSWORD = result[1]
+        EGERIA_PLATFORM_URL = result[2]
+        EGERIA_VIEW_SERVER = result[3]
+
+        await self.action_dismiss(result)
+
+    @on(Button.Pressed, "#cancel")
+    def on_cancel(self) -> None:
+        self.action_dismiss()
+
+
+class ExitScreen(ModalScreen):
+    """App exit screen."""
+
+    DEFAULT_CSS = """
+    ExitScreen {
+        align: center middle;
+    }
+
+    ExitScreen > Container {
+        width: auto;
+        height: auto;
+    }
+    """
+
+    BINDINGS = [("d", "toggle_dark", "Toggle dark mode")]
+
+    def __init__(self) -> None:
+        """Initialize the UserInfo Screen variables"""
+        super().__init__()
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark mode."""
+        self.app.dark = not self.app.dark
+
+    def compose(self) -> ComposeResult:
+        with Container():
+            yield Label("Are you sure you want to quit?")
+            yield Button("No", id="no", variant="error")
+            yield Button("Yes", id="yes", variant="success")
+            yield Footer()
+            yield RichLog()
+
+    @on(Button.Pressed, "#no")
+    def on_no(self) -> None:
+        """No the user pressed the exit button in error"""
+        self.action_dismiss()
+
+    @on(Button.Pressed, "#yes")
+    def on_yes(self) -> None:
+        """Yes the user wants to quit the app"""
+        self.app.exit()
+
+
+class Egeria_login(App):
+    """main app class"""
+
+    CSS_PATH = "txt_custom_v2.tcss"
+
+    BINDINGS = [("d", "toggle_dark", "Toggle dark mode")]
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        dark = Reactive(True, compute=False)
+        self.app.dark = False
+        self.template: Any = None
+
+    def compose(self) -> ComposeResult:
+        """Compose the main display"""
+
+        yield Label(f"User: {EGERIA_USER}, password: {EGERIA_USER_PASSWORD}")
+        yield Label(
+            f"Platform: {EGERIA_PLATFORM_URL}, View Server: {EGERIA_VIEW_SERVER}"
+        )
+        yield Button("Finish", "success", id="finish")
+        yield RichLog()
+        yield Footer()
+
+    def on_button_pressed(self, event: Button.Pressed) -> (str, str, str, str):
+        """Yes the user wants to quit the app"""
+
+        self.exit(
+            (
+                EGERIA_USER,
+                EGERIA_USER_PASSWORD,
+                EGERIA_PLATFORM_URL,
+                EGERIA_VIEW_SERVER,
+            ),
+            200,
+            "Finished",
+        )
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark and light mode."""
+        self.app.dark = not self.app.dark
+
+    async def on_mount(self) -> None:
+        """Main Program flow control start routine
+        Pushes the user info popup with an associated call back routine"""
+
+        global EGERIA_USER
+        global EGERIA_USER_PASSWORD
+        global EGERIA_PLATFORM_URL
+        global EGERIA_VIEW_SERVER
+
+        system("clear")
+        # Display User Info Screen
+        self.install_screen(UserInfo(), name="userinfo")
+        await self.push_screen(UserInfo(), self.input_userinfo_callback)
+
+    async def input_userinfo_callback(self, user_input) -> (str, str, str, str):
+        """Prompt for user id and password, callback routine
+        This routine is invoked when user input is completed
+        """
+
+        global EGERIA_USER
+        global EGERIA_USER_PASSWORD
+        global EGERIA_PLATFORM_URL
+        global EGERIA_VIEW_SERVER
+        global TECH_NAME
+
+        if user_input[0] != None:
+            EGERIA_USER = user_input[0]
+        else:
+            EGERIA_USER = "erinoverview"
+        if user_input[1] != None:
+            EGERIA_USER_PASSWORD = user_input[1]
+        else:
+            EGERIA_USER_PASSWORD = "secret"
+        if user_input[2] != None:
+            EGERIA_PLATFORM_URL = user_input[2]
+        else:
+            EGERIA_PLATFORM_URL = "https://localhost:9443"
+        if user_input[3] != None:
+            EGERIA_VIEW_SERVER = user_input[3]
+        else:
+            EGERIA_VIEW_SERVER = "view-server"
+
+        return (
+            EGERIA_USER,
+            EGERIA_USER_PASSWORD,
+            EGERIA_PLATFORM_URL,
+            EGERIA_VIEW_SERVER,
+        )
+
+
+# @click.command("egeria-login")
+# @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")
+def login(userid: str, password: str, server: str, url: str) -> None:
+    app = Egeria_login()
+    app.run()
+    return "peterprofile"
+
+
+if __name__ == "__main__":
+    app = Egeria_login()
+    app.run()

pyegeria/commands/cli/egeria_my.py

@@ -0,0 +1,248 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+A command line interface for Egeria Users - of individual relevance
+
+This is an emerging capability based on the **click** package. Feedback welcome!
+
+"""
+import os
+
+import click
+from trogon import tui
+
+from pyegeria.commands.cli.ops_config import Config
+
+from pyegeria.commands.my.monitor_open_todos import display_todos
+from pyegeria.commands.my.monitor_my_todos import display_my_todos
+from pyegeria.commands.my.list_my_profile import display_my_profile
+from pyegeria.commands.my.list_my_roles import display_my_roles
+from pyegeria.commands.my.todo_actions import (
+    create_todo,
+    delete_todo,
+    change_todo_status,
+    mark_todo_complete,
+    reassign_todo,
+)
+
+
+# class Config(object):
+#     def __init__(self, server: str = None, url: str = None, userid:str = None, password:str = None,
+#                  timeout:int = 30, paging: bool = False):
+#         self.server = server
+#         self.url = url
+#         self.userid = userid
+#         self.password = password
+#         self.timeout = timeout
+#         self.paging = paging
+#
+#
+# pass_config = click.make_pass_decorator(Config)
+
+
+@tui()
+# @tui('menu', 'menu', 'A textual command line interface')
+@click.version_option("0.0.1", prog_name="egeria_ops")
+@click.group()
+@click.option(
+    "--server",
+    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
+    help="Egeria metadata store to work with",
+)
+@click.option(
+    "--url",
+    default=os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443"),
+    help="URL of Egeria metadata store platform to connect to",
+)
+@click.option(
+    "--integration_daemon",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
+    help="Egeria integration daemon to work with",
+)
+@click.option(
+    "--integration_daemon_url",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"),
+    help="URL of Egeria integration daemon platform to connect to",
+)
+@click.option(
+    "--view_server",
+    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
+    help="Egeria view server to work with",
+)
+@click.option(
+    "--view_server_url",
+    default=os.environ.get("EGERIA_VIEW_SERVER_URL", "https://localhost:9443"),
+    help="URL of Egeria view server platform to connect to",
+)
+@click.option(
+    "--engine_host",
+    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
+    help="Egeria engine host to work with",
+)
+@click.option(
+    "--engine_host_url",
+    default=os.environ.get("EGERIA_ENGINE_HOST_URL", "https://localhost:9443"),
+    help="URL of Egeria engine host platform to connect to",
+)
+@click.option(
+    "--admin_user",
+    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
+    help="Egeria admin user",
+)
+@click.option(
+    "--admin_user_password",
+    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
+    help="Egeria admin password",
+)
+@click.option(
+    "--userid",
+    default=os.environ.get("EGERIA_USER", "peterprofile"),
+    help="Egeria user",
+)
+@click.option(
+    "--password",
+    default=os.environ.get("EGERIA_USER_PASSWORD", "secret"),
+    help="Egeria user password",
+)
+@click.option("--timeout", default=60, help="Number of seconds to wait")
+@click.option(
+    "--jupyter",
+    is_flag=True,
+    default=os.environ.get("EGERIA_JUPYTER", "False"),
+    help="Enable for rendering in a Jupyter terminal",
+)
+@click.option(
+    "--width",
+    default=os.environ.get("EGERIA_WIDTH", "200"),
+    help="Screen width, in characters, to use",
+)
+@click.option(
+    "--home_glossary_guid",
+    default=os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None),
+    help="Glossary guid to use as the home glossary",
+)
+@click.pass_context
+def cli(
+    ctx,
+    server,
+    url,
+    view_server,
+    view_server_url,
+    integration_daemon,
+    integration_daemon_url,
+    engine_host,
+    engine_host_url,
+    admin_user,
+    admin_user_password,
+    userid,
+    password,
+    timeout,
+    jupyter,
+    width,
+):
+    """An Egeria Command Line interface for Operations"""
+    ctx.obj = Config(
+        server,
+        url,
+        view_server,
+        view_server_url,
+        integration_daemon,
+        integration_daemon_url,
+        engine_host,
+        engine_host_url,
+        admin_user,
+        admin_user_password,
+        userid,
+        password,
+        timeout,
+        jupyter,
+        width,
+    )
+    ctx.max_content_width = 200
+    ctx.ensure_object(Config)
+
+
+@cli.group("show")
+@click.pass_context
+def show(ctx):
+    """Display an Egeria Object"""
+    pass
+
+
+@show.command("my-profile")
+@click.pass_context
+def show_my_profile(ctx):
+    """Display my profiles
+
+    Usage: show my-profile
+
+    """
+    c = ctx.obj
+    display_my_profile(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("my-roles")
+@click.pass_context
+def show_my_roles(ctx):
+    """Display my roles"""
+    c = ctx.obj
+    display_my_roles(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("my-to-dos")
+@click.pass_context
+def show_my_todos(ctx):
+    """Show my To-Dos
+
+    Usage: show my-to-dos
+
+    """
+    c = ctx.obj
+    display_my_todos(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("open-to-dos")
+@click.pass_context
+def show_open_todos(ctx):
+    """Display a live status view of Egeria servers for the specified Egeria platform
+
+    Usage: show tech-details <tech-name>
+
+           tech-name is a valid technology name (see 'show tech-types')
+    """
+    c = ctx.obj
+    display_todos(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+#
+#  Tell
+#
+
+
+@cli.group("tell")
+@click.pass_context
+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__":
+    cli()