pyegeria 0.7.45.1__tar.gz → 0.8.0__tar.gz

{pyegeria-0.7.45.1 → pyegeria-0.8.0}/PKG-INFO

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

{pyegeria-0.7.45.1 → pyegeria-0.8.0}/examples/widgets/cat/list_cert_types.py

@@ -26,35 +26,49 @@ from pyegeria import (
     UserNotAuthorizedException,
     print_exception_response,
     AssetCatalog,
-    ClassificationManager
+    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_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'))
+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"))
 
 
 disable_ssl_warnings = True
 
 
-def display_certifications(search_string: str, server: str, url: str, username: str, user_password: str, time_out: int = 60,
-                   jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH):
+def display_certifications(
+    search_string: str,
+    server: str,
+    url: str,
+    username: str,
+    user_password: str,
+    time_out: int = 60,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
     console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
-    if (search_string is None) or ((len(search_string) < 3)) and (search_string != '*'):
-        raise ValueError("Invalid Search String - must be greater than four characters long")
-    g_client = ClassificationManager(server, url, user_id=username,user_pwd=user_password)
+    if (search_string is None) or ((len(search_string) < 3)) and (search_string != "*"):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = ClassificationManager(
+        server, url, user_id=username, user_pwd=user_password
+    )
     token = g_client.create_egeria_bearer_token(username, user_password)
 
-
-    def generate_table(search_string:str = None) -> Table:
+    def generate_table(search_string: str = None) -> Table:
         """Make a new table."""
         table = Table(
             title=f"Certifications Types  @ {time.asctime()}",
@@ -66,10 +80,10 @@ def display_certifications(search_string: str, server: str, url: str, username:
             show_lines=True,
             box=box.ROUNDED,
             caption=f"View Server '{server}' @ Platform - {url}",
-            expand=True
+            expand=True,
         )
         table.add_column("Title", max_width=15)
-        table.add_column('summary')
+        table.add_column("summary")
         table.add_column("domainID")
         table.add_column("Unique Name")
         table.add_column("Scope")
@@ -78,34 +92,33 @@ def display_certifications(search_string: str, server: str, url: str, username:
         table.add_column("Details")
         table.add_column("Related Elements")
 
-
         certs = g_client.get_elements(search_string, page_size=100, time_out=time_out)
         if type(certs) is str:
             return table
 
         for element in certs:
-            properties = element['properties']
-            summary = properties.get('summary',"---")
-            domain = properties.get("domainIdentifier",'---')
-            unique_name = properties.get('qualifiedName','---')
-            scope = properties.get('scope','---')
-            description = properties.get('description','---')
-            details = properties.get('details','---')
-            title = properties.get('title','---')
-            cert_guid = element['elementHeader']['guid']
+            properties = element["properties"]
+            summary = properties.get("summary", "---")
+            domain = properties.get("domainIdentifier", "---")
+            unique_name = properties.get("qualifiedName", "---")
+            scope = properties.get("scope", "---")
+            description = properties.get("description", "---")
+            details = properties.get("details", "---")
+            title = properties.get("title", "---")
+            cert_guid = element["elementHeader"]["guid"]
 
             related = g_client.get_all_related_elements(cert_guid)
             if (len(related) > 0) and (type(related) is list):
-                rel_md = ''
+                rel_md = ""
                 for rel in related:
-                    rel_type = rel['relationshipHeader']['type']['typeName']
-                    rel_element_props = rel['relatedElement']['properties']
+                    rel_type = rel["relationshipHeader"]["type"]["typeName"]
+                    rel_element_props = rel["relatedElement"]["properties"]
                     rel_el_md = f"* Rel Type: {rel_type}\n"
                     for key in rel_element_props.keys():
                         rel_el_md += f"* {key}: {rel_element_props[key]}\n"
                     rel_md += f"----\n{rel_el_md}\n"
             else:
-                rel_md = '---'
+                rel_md = "---"
 
             # match_tab = Table(expand=True)
             # match_tab.add_column("Type Name")
@@ -122,9 +135,8 @@ def display_certifications(search_string: str, server: str, url: str, username:
             #     match_details_out = Markdown(match_details_md)
             #     match_tab.add_row(match_type_name, matching_guid, match_details_out)
 
-
             table.add_row(
-                title, summary, domain, unique_name,scope,description,details, rel_md
+                title, summary, domain, unique_name, scope, description, details, rel_md
             )
 
         g_client.close_session()
@@ -140,13 +152,18 @@ def display_certifications(search_string: str, server: str, url: str, username:
         with console.pager(styles=True):
             console.print(generate_table(search_string), soft_wrap=True)
 
-
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
         console.print_exception()
         sys.exit(1)
 
     except ValueError as e:
-        console.print(f"\n\n====> Invalid Search String - must be greater than four characters long")
+        console.print(
+            f"\n\n====> Invalid Search String - must be greater than four characters long"
+        )
         sys.exit(1)
 
 
@@ -167,10 +184,11 @@ def main():
     time_out = args.time_out if args.time_out is not None else 60
     try:
         # search_string = Prompt.ask("Enter an asset search string:", default="*")
-        search_string = 'CertificationType'
+        search_string = "CertificationType"
         display_certifications(search_string, server, url, userid, user_pass, time_out)
-    except(KeyboardInterrupt):
+    except KeyboardInterrupt:
         pass
 
+
 if __name__ == "__main__":
-    main()
+    main()

{pyegeria-0.7.45.1 → pyegeria-0.8.0}/examples/widgets/cat/list_projects.py

@@ -59,7 +59,7 @@ def display_project_list(
 ):
     p_client = ProjectManager(server, url, user_id=username)
     token = p_client.create_egeria_bearer_token(username, user_pass)
-    c_client = ClassificationManager(server, url, token)
+    c_client = ClassificationManager(server, url, token=token)
 
     def generate_table(project_name: str) -> Table:
         """Make a new table."""

{pyegeria-0.7.45.1 → pyegeria-0.8.0}/examples/widgets/my/my_profile_actions.py

@@ -22,79 +22,97 @@ from pyegeria._exceptions import (
 )
 
 
-@click.command('add-todo')
-@click.argument('integration-connector')
-@click.argument('metadata-element-guid')
-@click.argument('catalog-target-name')
+@click.command("add-todo")
+@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:
+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')
+            click.echo("Integration connector is not known")
 
         c = ctx.obj
-        a_client = AutomatedCuration(c.view_server, c.view_server_url, c.userid, c.password)
+        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}")
+        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.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)
+        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}")
-
+        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.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 """
+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)
+        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}")
-
+        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)
 
 
-@click.command('stop')
+@click.command("stop")
 @click.pass_context
 def stop_server(ctx):
     """Stop an integration daemon"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.shutdown_server()
 
@@ -103,13 +121,15 @@ def stop_server(ctx):
         print_exception_response(e)
 
 
-@click.command('start')
+@click.command("start")
 @click.pass_context
 def start_server(ctx):
-    """Start or restart an integration daemon from its known configuration """
+    """Start or restart an integration daemon from its known configuration"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.activate_server_stored_config()
 
@@ -117,4 +137,3 @@ def start_server(ctx):
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
-

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

@@ -0,0 +1,83 @@
+"""
+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()

{pyegeria-0.7.45.1 → pyegeria-0.8.0}/examples/widgets/ops/integration_daemon_actions.py

@@ -22,79 +22,97 @@ from pyegeria._exceptions import (
 )
 
 
-@click.command('add-target')
-@click.argument('integration-connector')
-@click.argument('metadata-element-guid')
-@click.argument('catalog-target-name')
+@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:
+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')
+            click.echo("Integration connector is not known")
 
         c = ctx.obj
-        a_client = AutomatedCuration(c.view_server, c.view_server_url, c.userid, c.password)
+        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}")
+        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.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)
+        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}")
-
+        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.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 """
+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)
+        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}")
-
+        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)
 
 
-@click.command('stop')
+@click.command("stop")
 @click.pass_context
 def stop_server(ctx):
     """Stop an integration daemon"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.shutdown_server()
 
@@ -103,13 +121,15 @@ def stop_server(ctx):
         print_exception_response(e)
 
 
-@click.command('start')
+@click.command("start")
 @click.pass_context
 def start_server(ctx):
-    """Start or restart an integration daemon from its known configuration """
+    """Start or restart an integration daemon from its known configuration"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.activate_server_stored_config()
 
@@ -117,4 +137,3 @@ def start_server(ctx):
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
-