pyegeria 5.2__py3-none-any.whl → 5.2.0.1__py3-none-any.whl

pyegeria/commands/cli/egeria_cat.py

@@ -9,8 +9,6 @@ A command line interface for Egeria Catalog User functions
 This is an emerging capability based on the **click** package. Feedback welcome!
 
 """
-import os
-
 import click
 from trogon import tui
 
@@ -19,7 +17,6 @@ from pyegeria.commands.cat.get_collection import collection_viewer
 from pyegeria.commands.cat.get_project_dependencies import project_dependency_viewer
 from pyegeria.commands.cat.get_project_structure import project_structure_viewer
 from pyegeria.commands.cat.get_tech_type_elements import tech_viewer
-from pyegeria.commands.cat.list_tech_type_elements import list_tech_elements
 from pyegeria.commands.cat.glossary_actions import (
     create_glossary,
     delete_glossary,
@@ -44,7 +41,7 @@ from pyegeria.commands.cat.list_todos import display_to_dos as list_todos
 from pyegeria.commands.cat.list_user_ids import list_user_ids
 from pyegeria.commands.cat.list_collections import display_collections
 
-
+# from pyegeria import ServerOps
 from pyegeria.commands.cli.ops_config import Config
 from pyegeria.commands.my.todo_actions import (
     mark_todo_complete,
@@ -55,6 +52,20 @@ from pyegeria.commands.my.todo_actions import (
 from pyegeria.commands.tech.list_asset_types import display_asset_types
 
 
+# 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')
 @tui()
@@ -62,82 +73,87 @@ from pyegeria.commands.tech.list_asset_types import display_asset_types
 @click.group()
 @click.option(
     "--server",
-    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
+    default="active-metadata-store",
+    envvar="EGERIA_METADATA_STORE",
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default=os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443"),
+    default="https://localhost:9443",
+    envvar="EGERIA_PLATFORM_URL",
     help="URL of Egeria metadata store platform to connect to",
 )
 @click.option(
     "--integration_daemon",
-    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
+    default="integration-daemon",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_INTEGRATION_DAEMON_URL",
     help="URL of Egeria integration daemon platform to connect to",
 )
 @click.option(
     "--view_server",
-    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
+    default="view-server",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_VIEW_SERVER_URL",
     help="URL of Egeria view server platform to connect to",
 )
 @click.option(
     "--engine_host",
-    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
+    default="engine-host",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_ENGINE_HOST_URL",
     help="URL of Egeria engine host platform to connect to",
 )
 @click.option(
     "--admin_user",
-    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
+    default="garygeeke",
+    envvar="EGERIA_ADMIN_USER",
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_ADMIN_PASSWORD",
     help="Egeria admin password",
 )
 @click.option(
-    "--userid",
-    default=os.environ.get("EGERIA_USER", "peterprofile"),
-    help="Egeria user",
+    "--userid", default="erinoverview", envvar="EGERIA_USER", help="Egeria user"
 )
 @click.option(
     "--password",
-    default=os.environ.get("EGERIA_USER_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_PASSWORD",
     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"),
+    default=False,
+    envvar="EGERIA_JUPYTER",
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=os.environ.get("EGERIA_WIDTH", 200),
-    type=int,
+    default=200,
+    envvar="EGERIA_WIDTH",
     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,
@@ -156,7 +172,6 @@ def cli(
     timeout,
     jupyter,
     width,
-    home_glossary_guid,
 ):
     """An Egeria Command Line interface for Operations"""
     ctx.obj = Config(
@@ -175,9 +190,8 @@ def cli(
         timeout,
         jupyter,
         width,
-        home_glossary_guid,
     )
-    ctx.max_content_width = 250
+    ctx.max_content_width = 200
     ctx.ensure_object(Config)
 
 
@@ -208,11 +222,11 @@ def show_tech_types(ctx, tech_type):
 @info.command("collections")
 @click.option("--collection", default="*", help="Collection to search for")
 @click.pass_context
-def show_collections(ctx, collection):
+def show_collections(ctx, collections):
     """List Collections"""
     c = ctx.obj
     display_collections(
-        collection, c.view_server, c.view_server_url, c.userid, c.password
+        collections, c.view_server, c.view_server_url, c.userid, c.password
     )
 
 
@@ -230,21 +244,6 @@ def asset_group(ctx):
     help="Specific tech type to get elements for",
 )
 @click.pass_context
-def list_tech_type_elements(ctx, tech_type):
-    """List technology type elements"""
-    c = ctx.obj
-    list_tech_elements(
-        tech_type, c.view_server, c.view_server_url, c.userid, c.password
-    )
-
-
-@asset_group.command("elements-of-tech-type")
-@click.option(
-    "--tech_type",
-    default="PostgreSQL Server",
-    help="Specific tech type to get elements for",
-)
-@click.pass_context
 def show_tech_type_elements(ctx, tech_type):
     """List technology type elements"""
     c = ctx.obj
@@ -312,7 +311,7 @@ def glossary_group(ctx):
 )
 @click.option(
     "--glossary-guid",
-    default=os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None),
+    default=None,
     help="Optionally restrict search to glossary with the specified guid",
 )
 @click.option(
@@ -341,7 +340,7 @@ def show_terms(ctx, search_string, glossary_guid, glossary_name):
 @click.option("--search_string", default="*", help="Name to search for glossaries")
 @click.pass_context
 def glossaries(ctx, search_string):
-    """Display a list of glossaries"""
+    """Display information about a collection"""
     c = ctx.obj
     display_glossaries(
         search_string,
@@ -357,12 +356,12 @@ def glossaries(ctx, search_string):
 @info.command("collection")
 @click.option(
     "--root_collection",
-    default="Digital Product Root",
+    default="Root Sustainability Collection",
     help="View of tree of collections from a given root",
 )
 @click.pass_context
-def show_collection(ctx, root_collection):
-    """Display a collection"""
+def show_asset_graph(ctx, root_collection):
+    """Display a tree graph of information about an asset"""
     c = ctx.obj
     collection_viewer(
         root_collection,
@@ -404,7 +403,9 @@ def show_projects(ctx, search_string):
 @click.option("--search-string", default="CertificationType", help="")
 @click.pass_context
 def show_certification_types(ctx, search_string):
-    """Show certification types"""
+    """Show certification types
+    - generally stay with the default.
+    """
     c = ctx.obj
     display_certifications(
         search_string,
@@ -476,7 +477,7 @@ def show_project_dependencies(ctx, project):
 )
 @click.pass_context
 def show_todos(ctx, search_string, status):
-    """Display a list of To Dos"""
+    """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_todos(
         search_string,

pyegeria/commands/cli/egeria_my.py

@@ -9,8 +9,6 @@ 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
 
@@ -49,81 +47,87 @@ from pyegeria.commands.my.todo_actions import (
 @click.group()
 @click.option(
     "--server",
-    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
+    default="active-metadata-store",
+    envvar="EGERIA_METADATA_STORE",
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default=os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443"),
+    default="https://localhost:9443",
+    envvar="EGERIA_PLATFORM_URL",
     help="URL of Egeria metadata store platform to connect to",
 )
 @click.option(
-    "--integration_daemon",
-    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
+    "--integration-daemon",
+    default="integration-daemon",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_INTEGRATION_DAEMON_URL",
     help="URL of Egeria integration daemon platform to connect to",
 )
 @click.option(
     "--view_server",
-    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
+    default="view-server",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_VIEW_SERVER_URL",
     help="URL of Egeria view server platform to connect to",
 )
 @click.option(
     "--engine_host",
-    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
+    default="engine-host",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_ENGINE_HOST_URL",
     help="URL of Egeria engine host platform to connect to",
 )
 @click.option(
     "--admin_user",
-    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
+    default="garygeeke",
+    envvar="EGERIA_ADMIN_USER",
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_ADMIN_PASSWORD",
     help="Egeria admin password",
 )
 @click.option(
-    "--userid",
-    default=os.environ.get("EGERIA_USER", "peterprofile"),
-    help="Egeria user",
+    "--userid", default="erinoverview", envvar="EGERIA_USER", help="Egeria user"
 )
 @click.option(
     "--password",
-    default=os.environ.get("EGERIA_USER_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_PASSWORD",
     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"),
+    default=False,
+    envvar="EGERIA_JUPYTER",
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=os.environ.get("EGERIA_WIDTH", "200"),
+    default=200,
+    envvar="EGERIA_WIDTH",
     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,
@@ -189,7 +193,11 @@ def show_my_profile(ctx):
 @show.command("my-roles")
 @click.pass_context
 def show_my_roles(ctx):
-    """Display my roles"""
+    """Display my profiles
+
+    Usage: show my-profile
+
+    """
     c = ctx.obj
     display_my_roles(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width

pyegeria/commands/cli/egeria_ops.py

@@ -9,8 +9,6 @@ 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
 
@@ -65,81 +63,85 @@ from pyegeria.commands.ops.list_archives import display_archive_list
 @click.group()
 @click.option(
     "--server",
-    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
+    default="active-metadata-store",
+    envvar="EGERIA_METADATA_STORE",
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default=os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443"),
+    default="https://localhost:9443",
+    envvar="EGERIA_PLATFORM_URL",
     help="URL of Egeria metadata store platform to connect to",
 )
 @click.option(
-    "--integration_daemon",
-    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
+    "--integration-daemon",
+    default="integration-daemon",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_INTEGRATION_DAEMON_URL",
     help="URL of Egeria integration daemon platform to connect to",
 )
 @click.option(
     "--view_server",
-    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
+    default="view-server",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_VIEW_SERVER_URL",
     help="URL of Egeria view server platform to connect to",
 )
 @click.option(
     "--engine_host",
-    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
+    default="engine-host",
+    envvar="EGERIA_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"),
+    default="https://localhost:9443",
+    envvar="EGERIA_ENGINE_HOST_URL",
     help="URL of Egeria engine host platform to connect to",
 )
 @click.option(
     "--admin_user",
-    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
+    default="garygeeke",
+    envvar="EGERIA_ADMIN_USER",
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_ADMIN_PASSWORD",
     help="Egeria admin password",
 )
-@click.option(
-    "--userid",
-    default=os.environ.get("EGERIA_USER", "peterprofile"),
-    help="Egeria user",
-)
+@click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
 @click.option(
     "--password",
-    default=os.environ.get("EGERIA_USER_PASSWORD", "secret"),
+    default="secret",
+    envvar="EGERIA_USER_PASSWORD",
     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"),
+    default=False,
+    envvar="EGERIA_JUPYTER",
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=os.environ.get("EGERIA_WIDTH", "200"),
+    default=200,
+    envvar="EGERIA_WIDTH",
     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,
@@ -252,7 +254,7 @@ def show_startup_status(ctx):
 @show_server.command("archives")
 @click.pass_context
 def list_archives(ctx):
-    """Display a list of archives"""
+    """Display a tree graph of information about an asset"""
     c = ctx.obj
     display_archive_list(
         c.view_server,
@@ -292,14 +294,14 @@ def gov_eng_status(ctx, engine_list, engine_host, list):
     c = ctx.obj
     display_gov_eng_status(
         [engine_list],
-        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,
+        engine_host,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        list,
+        c.jupyter,
+        c.width,
     )
 
 
@@ -371,7 +373,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],
@@ -387,7 +389,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):
@@ -430,7 +432,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