pyegeria 5.2.1__py3-none-any.whl → 5.3__py3-none-any.whl

{pyegeria/commands → commands}/cat/get_project_dependencies.py

@@ -18,24 +18,22 @@ from rich.prompt import Prompt
 from rich.tree import Tree
 
 from pyegeria import (
+    InvalidParameterException,
     ProjectManager,
-    UserNotAuthorizedException,
     PropertyServerException,
-    InvalidParameterException,
-)
-from pyegeria._exceptions import (
-    print_exception_response,
+    UserNotAuthorizedException,
 )
+from pyegeria._exceptions import print_exception_response
 
 disable_ssl_warnings = True
 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 = os.environ.get("EGERIA_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 = os.environ.get("EGERIA_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")
@@ -111,7 +109,7 @@ def project_dependency_viewer(
                 child_md = ""
                 child_guid = proj["elementHeader"]["guid"]
                 child_name = proj["properties"]["name"]
-                relationship = proj["relatedElement"]["relationshipHeader"]["type"][
+                relationship = proj["startingElement"]["relationshipHeader"]["type"][
                     "typeName"
                 ]
                 if relationship != "ProjectDependency":

{pyegeria/commands → commands}/cat/get_project_structure.py

@@ -18,24 +18,22 @@ from rich.prompt import Prompt
 from rich.tree import Tree
 
 from pyegeria import (
+    InvalidParameterException,
     ProjectManager,
-    UserNotAuthorizedException,
     PropertyServerException,
-    InvalidParameterException,
-)
-from pyegeria._exceptions import (
-    print_exception_response,
+    UserNotAuthorizedException,
 )
+from pyegeria._exceptions import print_exception_response
 
 disable_ssl_warnings = True
 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 = os.environ.get("EGERIA_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 = os.environ.get("EGERIA_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")
@@ -111,7 +109,7 @@ def project_structure_viewer(
                 child_md = ""
                 child_guid = proj["elementHeader"]["guid"]
                 child_name = proj["properties"]["name"]
-                relationship = proj["relatedElement"]["relationshipHeader"]["type"][
+                relationship = proj["startingElement"]["relationshipHeader"]["type"][
                     "typeName"
                 ]
                 if relationship != "ProjectHierarchy":

{pyegeria/commands → commands}/cat/get_tech_type_elements.py

@@ -5,39 +5,37 @@ Copyright Contributors to the ODPi Egeria project.
 
 Display the status of cataloged platforms and servers.
 """
-import sys
-import time
 import argparse
 import os
+import sys
+import time
 
-from rich import json
+from rich import json, print
+from rich.console import Console
+from rich.live import Live
+from rich.markdown import Markdown
 from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+from rich.tree import Tree
 
 from pyegeria import (
+    AutomatedCuration,
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    AutomatedCuration,
 )
-from rich.table import Table
-from rich.live import Live
-from rich.console import Console
-from rich.markdown import Markdown
-from rich.tree import Tree
-from rich.prompt import Prompt
-from rich.panel import Panel
-from rich.text import Text
-from rich import print
 
 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 = os.environ.get("EGERIA_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 = os.environ.get("EGERIA_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")

{pyegeria/commands → commands}/cat/glossary_actions.py

@@ -7,17 +7,13 @@ Copyright Contributors to the ODPi Egeria project.
 Execute Glossary actions.
 
 """
+
 import csv
 import json
 import os
 import sys
 import time
 from datetime import datetime
-from rich import box
-from rich.console import Console
-from rich.prompt import Prompt
-from rich.table import Table
-from rich.text import Text
 
 import click
 
@@ -29,15 +25,14 @@ from pyegeria._exceptions import (
     print_exception_response,
 )
 
-
 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 = os.environ.get("EGERIA_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 = os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon")
 EGERIA_INTEGRATION_DAEMON_URL = os.environ.get(
     "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
 )
@@ -133,7 +128,7 @@ def delete_glossary(server, url, userid, password, timeout, glossary_guid):
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
-        m_client.delete_glossary(glossary_guid)
+        m_client.delete_glossary(glossary_guid, cascade = True)
 
         click.echo(f"Deleted glossary: {glossary_guid}")
 
@@ -146,6 +141,7 @@ def delete_glossary(server, url, userid, password, timeout, glossary_guid):
 @click.command("create-term")
 @click.option("--glossary-name", help="Name of Glossary", required=True)
 @click.option("--term-name", help="Name of Term", required=True)
+@click.option("--qualified-name",  help="Qualified name of Term", default=None)
 @click.option(
     "--summary",
     help="Summary definition",
@@ -175,31 +171,23 @@ def delete_glossary(server, url, userid, password, timeout, glossary_guid):
 @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")
-def create_term(
-    server,
-    url,
-    userid,
-    password,
-    glossary_name,
-    term_name,
-    summary,
-    description,
-    abbrev,
-    examples,
-    usage,
-    version,
-    status,
-    timeout: int = 120,
-) -> str:
-    """Create a new term"""
+def create_term(server, url, userid, password, glossary_name, term_name, summary, description, abbrev, examples, usage,
+                version, status, timeout: int = 120, qualified_name=None) -> str:
+    """Create a new term
+
+    Args:
+        qualified_name:
+    """
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
+    if qualified_name is None:
+        qualified_name = m_client.__create_qualified_name__('Term', term_name)
     try:
         body = {
             "class": "ReferenceableRequestBody",
             "elementProperties": {
                 "class": "GlossaryTermProperties",
-                "qualifiedName": f"GlossaryTerm: {term_name} - {datetime.now().isoformat()}",
+                "qualifiedName": qualified_name,
                 "displayName": term_name,
                 "summary": summary,
                 "description": description,
@@ -264,10 +252,68 @@ def delete_term(server, url, userid, password, timeout, term_guid):
     finally:
         m_client.close_session()
 
+@click.command("add-term-to-category")
+@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("--term-guid", required=True, help="GUID of term to add to a category")
+@click.option("--category-guid", required=True, help="GUID of category to add term to")
+
+def add_term_to_category(server, url, userid, password, timeout, term_guid, category_guid):
+    """Add a glossary term to a category"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        term_guid = term_guid.strip()
+        category_guid = category_guid.strip()
+        m_client.add_term_to_category(term_guid, category_guid)
+
+        click.echo(
+            f"Added term with GUID: {term_guid} to category with GUID: {category_guid}\n"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
 
-@click.command("import-terms")
+@click.command("remove-term-from-category")
+@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("--term-guid", required=True, help="GUID of term to add to a category")
+@click.option("--category-guid", required=True, help="GUID of category to add term to")
+
+def remove_term_from_category(server, url, userid, password, timeout, term_guid, category_guid):
+    """Add a glossary term to a category"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        term_guid = term_guid.strip()
+        category_guid = category_guid.strip()
+        m_client.remove_term_from_category(term_guid, category_guid)
+
+        click.echo(
+            f"Removed term with GUID: {term_guid} from category with GUID: {category_guid}\n"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command("import-terms-from-csv")
 @click.option("--glossary_name", help="Name of Glossary", required=True)
-@click.option("--file_name", help="Path of CSV file", required=True)
+@click.option("--file_name", help="Name of CSV file", required=True)
 @click.option(
     "--file_path", help="Path of CSV file", default=EGERIA_GLOSSARY_PATH, required=False
 )
@@ -290,7 +336,7 @@ def delete_term(server, url, userid, password, timeout, term_guid):
 @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")
-def import_terms(
+def import_terms_csv(
     glossary_name: str,
     file_path: str,
     file_name: str,
@@ -306,7 +352,7 @@ def import_terms(
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
-        result = m_client.load_terms_from_file(
+        result = m_client.load_terms_from_csv_file(
             glossary_name,
             file_name,
             file_path=file_path,
@@ -326,13 +372,13 @@ def import_terms(
         m_client.close_session()
 
 
-@click.command("export-terms")
+@click.command("export-terms-csv")
 @click.option(
     "--glossary_guid",
     help="GUID of Glossary to export",
     required=True,
 )
-@click.option("--file_name", help="Path of CSV file", required=True)
+@click.option("--file_name", help="Name of CSV file", required=True)
 @click.option(
     "--file_path", help="Path of CSV file", default=EGERIA_GLOSSARY_PATH, required=False
 )
@@ -343,7 +389,7 @@ def import_terms(
 @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")
-def export_terms(
+def export_terms_csv(
     glossary_guid: str, file_name, file_path, server, url, userid, password, timeout
 ):
     """Export the glossary specified"""
@@ -360,3 +406,107 @@ def export_terms(
         print_exception_response(e)
     finally:
         m_client.close_session()
+
+
+@click.command("create-category")
+@click.option("--name", help="Name of glossary Category", required=True)
+@click.option("--glossary_name", help="Glossary name", required=True)
+@click.option(
+    "--description",
+    help="Description of Category",
+    default="A description goes here",
+)
+@click.option(
+    "--is_root",
+    help="Is this a root category?",
+    default=True,
+    is_flag=True,
+)
+@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")
+def create_category(
+    server: str,
+    url: str,
+    userid: str,
+    password: str,
+    timeout: int,
+    name: str,
+    glossary_name: str,
+    description: str,
+    is_root: bool,
+) -> None:
+    """Create a new Glossary Category"""
+
+    try:
+        m_client = EgeriaTech(server, url, userid, password)
+        token = m_client.create_egeria_bearer_token()
+
+        existing_glossary = m_client.find_glossaries(glossary_name)
+        if type(existing_glossary) is str:
+            click.echo(existing_glossary)
+            sys.exit(0)
+        if type(existing_glossary) is list and len(existing_glossary) == 1:
+            q_name = existing_glossary["glossaryProperties"]["qualifiedName"]
+            glossary_guid = existing_glossary["elementHeader"]["guid"]
+        category_guid = m_client.create_category(glossary_guid,name,description, is_root)
+        print(f"New categry \'{name}\' created with id of \'{category_guid}\'")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command("update-category")
+@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.argument("category-guid")
+@click.option("--name", help="Name of glossary Category", required=True)
+@click.option("--glossary_name", help="Glossary name", required=True)
+@click.option("--description", help="Description of Category", default="A description goes here")
+def update_category(category_guid, name, description, server, url, userid, password, timeout, ):
+    """Delete the glossary specified"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        m_client.update_category(category_guid, name, description)
+
+        click.echo(f"Updated glossary: {category_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+@click.command("delete-category")
+@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.argument("category-guid")
+def delete_category(server, url, userid, password, timeout, category_guid):
+    """Delete the glossary specified"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        m_client.delete_category(category_guid)
+
+        click.echo(f"Deleted glossary: {category_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()

{pyegeria/commands → commands}/cat/list_assets.py

@@ -13,27 +13,27 @@ import time
 
 from rich import box
 from rich.console import Console
-from rich.prompt import Prompt
 from rich.markdown import Markdown
+from rich.prompt import Prompt
 from rich.table import Table
 from rich.text import Text
 
 from pyegeria import (
+    AssetCatalog,
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    AssetCatalog,
 )
 
 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 = os.environ.get("EGERIA_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 = os.environ.get("EGERIA_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")
@@ -99,8 +99,11 @@ def display_assets(
             header = element["elementHeader"]
             nested = element.get("matchingElements", "---")
             qualified_name = properties["qualifiedName"]
-            display_name = Text(f"{properties.get("displayName", "---")}\n\n{qualified_name}\n\n"
-                                f"{header['guid']}", justify="center")
+            display_name = Text(
+                f"{properties.get("displayName", "---")}\n\n{qualified_name}\n\n"
+                f"{header['guid']}",
+                justify="center",
+            )
 
             type_name = header["type"]["typeName"]
             tech_type = properties.get("deployedImplementationType", "---")