pyegeria 5.2.0.20__py3-none-any.whl → 5.2.0.42.2__py3-none-any.whl

pyegeria/commands/cli/egeria_ops.py

@@ -9,6 +9,8 @@ A command line interface for Egeria operations.
 This is an emerging capability based on the **click** package. Feedback welcome!
 
 """
+import os
+
 import click
 from trogon import tui
 
@@ -63,85 +65,81 @@ from pyegeria.commands.ops.list_archives import display_archive_list
 @click.group()
 @click.option(
     "--server",
-    default="active-metadata-store",
-    envvar="EGERIA_METADATA_STORE",
+    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default="https://localhost:9443",
-    envvar="EGERIA_PLATFORM_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="integration-daemon",
-    envvar="EGERIA_INTEGRATION_DAEMON",
+    "--integration_daemon",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
     help="Egeria integration daemon to work with",
 )
 @click.option(
     "--integration_daemon_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="view-server",
-    envvar="EGERIA_VIEW_SERVER",
+    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
     help="Egeria view server to work with",
 )
 @click.option(
     "--view_server_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="engine-host",
-    envvar="EGERIA_ENGINE_HOST",
+    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
     help="Egeria engine host to work with",
 )
 @click.option(
     "--engine_host_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="garygeeke",
-    envvar="EGERIA_ADMIN_USER",
+    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default="secret",
-    envvar="EGERIA_ADMIN_PASSWORD",
+    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
     help="Egeria admin password",
 )
-@click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
+@click.option(
+    "--userid",
+    default=os.environ.get("EGERIA_USER", "peterprofile"),
+    help="Egeria user",
+)
 @click.option(
     "--password",
-    default="secret",
-    envvar="EGERIA_USER_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=False,
-    envvar="EGERIA_JUPYTER",
+    default=os.environ.get("EGERIA_JUPYTER", "False"),
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=200,
-    envvar="EGERIA_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,
@@ -294,14 +292,14 @@ def gov_eng_status(ctx, engine_list, engine_host, list):
     c = ctx.obj
     display_gov_eng_status(
         [engine_list],
-        engine_host,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        list,
-        c.jupyter,
-        c.width,
+        engine_host=engine_host,
+        view_server=c.view_server,
+        url=c.view_server_url,
+        username=c.userid,
+        user_pass=c.password,
+        paging=list,
+        jupyter=c.jupyter,
+        width=c.width,
     )
 
 
@@ -373,7 +371,7 @@ def integrations(ctx):
 )
 @click.pass_context
 def integrations_status(ctx, connector_list, list):
-    """Display integration-daemon status information"""
+    """Display integration_daemon status information"""
     c = ctx.obj
     display_integration_daemon_status(
         [connector_list],
@@ -389,7 +387,7 @@ def integrations_status(ctx, connector_list, list):
     )
 
 
-@integrations.command("targets")
+@integrations.command("--targets")
 @click.pass_context
 @click.argument("connector", nargs=1)
 def integrations_status(ctx, connector):
@@ -432,7 +430,7 @@ servers.add_command(stop_server)
 @tell.group("integration-daemon")
 @click.pass_context
 def integration_daemon(ctx):
-    """Group of commands to an integration-daemon"""
+    """Group of commands to an integration_daemon"""
     pass
 
 

pyegeria/commands/cli/egeria_tech.py

@@ -9,6 +9,9 @@ A command line interface for Egeria Data techs.
 This is an emerging capability based on the **click** package. Feedback welcome!
 
 """
+import os
+import sys
+
 import click
 from trogon import tui
 
@@ -61,87 +64,81 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
 @click.group()
 @click.option(
     "--server",
-    default="active-metadata-store",
-    envvar="EGERIA_METADATA_STORE",
+    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default="https://localhost:9443",
-    envvar="EGERIA_PLATFORM_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="integration-daemon",
-    envvar="EGERIA_INTEGRATION_DAEMON",
+    "--integration_daemon",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
     help="Egeria integration daemon to work with",
 )
 @click.option(
     "--integration_daemon_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="view-server",
-    envvar="EGERIA_VIEW_SERVER",
+    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
     help="Egeria view server to work with",
 )
 @click.option(
     "--view_server_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="engine-host",
-    envvar="EGERIA_ENGINE_HOST",
+    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
     help="Egeria engine host to work with",
 )
 @click.option(
     "--engine_host_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_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="garygeeke",
-    envvar="EGERIA_ADMIN_USER",
+    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default="secret",
-    envvar="EGERIA_ADMIN_PASSWORD",
+    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
     help="Egeria admin password",
 )
 @click.option(
-    "--userid", default="peterprofile", envvar="EGERIA_USER", help="Egeria user"
+    "--userid",
+    default=os.environ.get("EGERIA_USER", "peterprofile"),
+    help="Egeria user",
 )
 @click.option(
     "--password",
-    default="secret",
-    envvar="EGERIA_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=False,
-    envvar="EGERIA_JUPYTER",
+    default=os.environ.get("EGERIA_JUPYTER", "False"),
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=200,
-    envvar="EGERIA_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,
@@ -213,7 +210,7 @@ def show_elements(ctx):
 @show_elements.command("guid-info")
 @click.argument("guid", nargs=1)
 @click.pass_context
-def show_guid_infos(ctx, guid):
+def show_guid_info(ctx, guid):
     """Display guid information
 
     Usage: show guid-info <a guid>
@@ -240,22 +237,39 @@ def show_related_specifications(ctx, element_guid):
     )
 
 
-@show_elements.command("element-graph")
+@show_elements.command("anchored-elements")
 @click.pass_context
-@click.option("--search-string", help="value we are searching for")
 @click.option(
-    "--prop-list", default="anchorTypeName", help="List of properties we are searching"
+    "--search-string",
+    default="SoftwareCapability",
+    help="value we are searching for",
+)
+@click.option(
+    "--prop-list",
+    default="anchorDomainName",
+    help="List of properties we are searching",
 )
-def list_element_graph(ctx, search_string: str, prop_list: str):
+def list_anchored_elements(ctx, search_string: str, prop_list: str):
     """List elements with the specified properties"""
     c = ctx.obj
+    # put guards around this to make it a list?
+    if type(prop_list) is str:
+        property_names = prop_list.split(",")
+    elif type(prop_list) is list:
+        property_names = prop_list
+    else:
+        property_names = []
+        print(f"\nError --> Invalid property list - must be a string or list")
+        sys.exit(4)
+
     display_anchored_elements(
         search_string,
-        prop_list,
+        property_names,
         c.view_server,
         c.view_server_url,
         c.userid,
         c.password,
+        c.timeout,
         c.jupyter,
         c.width,
     )
@@ -367,7 +381,7 @@ def show_registered_services(ctx, services):
 
 @show_info.command("relationship-types")
 @click.option(
-    "--rel-type",
+    "--om-type",
     default="AssetOwner",
     help="Relationship type to get information about",
 )

pyegeria/commands/cli/ops_config.py

@@ -8,7 +8,7 @@ class Config(object):
         url: str = None,
         view_server: str = "view-server",
         view_server_url: str = "https://localhost:9443",
-        integration_daemon: str = "integration-daemon",
+        integration_daemon: str = "integration_daemon",
         integration_daemon_url: str = "https://localhost:9443",
         engine_host: str = "engine-host",
         engine_host_url: str = "https://localhost:9443",
@@ -19,6 +19,7 @@ class Config(object):
         timeout: int = 30,
         jupyter: bool = False,
         width: int = 200,
+        home_glossary_guid: str = None,
     ):
         self.metadata_store = server
         self.metadata_store_url = url
@@ -37,6 +38,7 @@ class Config(object):
         self.width = width
         self.server = server
         self.url = url
+        self.home_glossary_guid = home_glossary_guid
 
 
 pass_config = click.make_pass_decorator(Config)

pyegeria/commands/doc/{command-overview.md → README.md}

@@ -1,18 +1,60 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
+
 # Overview
 
+**hey_egeria** is a friendly, easy to use, command line interface (CLI) for Egeria with both a scriptable component and a textual user
+interface to guide
+users through the different commands and options. This interface is being actively maintained and enhanced. There are
+currently about 70 commands in the interface and new ones are added based on perceived need and community feedback.
+
+The CLI is written in python using the [click](https://click.palletsprojects.com/en/stable/) package
+with [trogon](https://github.com/Textualize/trogon)
+providing the textual user interface. The commands are written using [pyegeria](https://github.com/odpi/egeria-python)
+or
+https://pypi.org/project/pyegeria/. Commands are also available standalone. Simple standalone installation instructions
+are
+documented at [pyegeria](https://egeria-project.org/concepts/pyegeria). pyegeria and hey_egeria are pre-installed within
+the **Egeria Workspaces** environment - [Egeria Workspaces](https://github.com/odpi/egeria-workspaces).
+
 # Command Line Interfaces
+## Commands
+A command line interface provides a simple language for users to invoke commands. In the case of **hey_egeria**, once it
+is installed, you can
+start simply by typing `hey_egeria` on the command line and it will provide a list of options and commands that you can
+use to interact with it. Commands are often arranged hierarchically - so, for instance if we type just `hey_egeria`, the
+command options presented to us are:
+
+```aiignore
+Commands:
+  cat   Commands for all users
+  my    Work with my information
+  ops   Commands to understand and manage operations
+  tech  Commands for tech Users
+  tui   Open Textual TUI
+```
 
-## hey_egeria
+"cat", "my", "ops", and "tech" represent groups of commands oriented towards particular roles. If a user wants to only
+use commands from a single role they can use a variant of hey_egeria that follows the pattern `hey_egeria_xxx`. So,
+for example, `hey_egeria_cat` is the entry point for general catalog users.
 
-## hey_egeria_cat
+Within each of these categories, commands are further split between **show** and **tell**. **Show** commands display
+information to the user on the terminal and **tell** commands instruct Egeria to take some action. Commands may be further
+sub-divided into topics.
 
-## hey_egeria_my
+So for example the command to display the status of the Egeria Platform is:
 
-## hey_egeria_ops
+`hey_egeria ops show platforms status` 
 
-## hey_egeria_tech
+And the command to list all glossaries is:
+
+`hey_egeria cat show glossary glossaries`
+
+## Options & Parameters
+
+Each command has a number of optional, and often some mandatory parameters. There are really two groups of options.
+* General options - that are present for every command. Sensible defaults based on environment variables are set for each.
+* Command specific optons & parameters
 
 # Command Reference
 
@@ -95,6 +137,9 @@
 | start_daemon                       | Start or restart an OMAG server from its known configuration |     |    | ✓   |      |        |
 | stop_daemon                        | Stop an OMAG server daemon                                   |     |    | ✓   |      |        |
 
+
+# Visual Command Reference
+A visual command reference of all the `hey_egeria` **show** commands can be found [Visual Command Reference](https://github.com/odpi/egeria-python/tree/main/pyegeria/commands/doc/Visual%20Command%20Reference)
 ----
 License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
 Copyright Contributors to the Egeria project.