pyegeria 5.3.6.2.4__py3-none-any.whl → 5.3.6.3__py3-none-any.whl

pyegeria/__init__.py

@@ -90,6 +90,9 @@ from .solution_architect_omvs import SolutionArchitect
 from .utils import body_slimmer, print_response
 from .valid_metadata_omvs import ValidMetadataManager
 from .x_action_author_omvs import ActionAuthor
+from .md_processing_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
+                                  process_categories_upsert_command,
+                                  get_current_datetime_string, process_per_proj_upsert_command, commands)
 
 #
 # The following assignments were generated by the `create_tech_guid_lists.py` utility that uses the pyegeria functions

pyegeria/commands/cat/{freddies-inbox → dr_egeria_inbox}/freddie_intro.md

@@ -1,12 +1,14 @@
+
 # Introduction to Freddie - an Egeria Markdown Processor
 
+
 A constant challenge in managing information is gathering enough metadata about the information to
 allow us to manage it. A common approach is to build fancy graphical user interfaces hoping that they
 will be attractive enough and easy enough to use that people will do so.
 
 Unfortunately, however, this ignores the fundamental fact that to use one of these nice GUI
 applications, you have to step away from the tools and processes that you were in the midst of performing.
-You have to leave your world and join someone elses.
+You have to leave your world and enter a new, often less familiar one.
 
 Freddie, is an experiment in turning this around. Its not that fancy graphical user
 interfaces don't have a role - but rather, to look at what we can do to support the
@@ -26,7 +28,7 @@ In the example below we will create a new Egeria glossary to hold definitions re
 
 ## Glossary Name
 
-Egeria-Markdown
+test
 
 ## Language
 
@@ -42,13 +44,7 @@ commands, validates the Egeria content and allows the requests to be sent to Ege
 
 ## Usage
 
-1. (optional) load an example or template for the type of object from Egeria.
-2. Create a new document (perhaps from the template) and edit it, adding in the content with the Freddie controlled
-   Markdown language.
-3. Process the document to validate and display it before you submit it, Validation may annotate your document with
-   recommendations and potential issues.
-4. Submit the document to Egeria using the Freddie_sings command.
-
+a quick test glossary
 ## <Qualified Name>
 
 ## <GUID>
@@ -85,15 +81,60 @@ We now have a nice, clean, new...and empty...glossary - guess we better start fi
 
 ---
 
+# Create Category
+
+## Category Name
+
+cat1
+
+## Owning Glossary
+
+test
+
+## Description
+
+These terms describe features of writing markdown files that can use Egeria-Markdown
+
+
+## <Qualified Name>
+
+## <GUID>
+
+---
+
+# Create Category
+
+## Category Name
+
+cat2
+
+## Owning Glossary
+
+test
+
+## Description
+
+These terms describe concepts related to processing Egeria-Markdown
+
+
+## <Qualified Name>
+
+## <GUID>
+---
+
 # Create Term
 
 ## Glossary Name
 
-Egeria-Markdown
+test
 
 ## Term Name
 
-Command
+t1
+
+## Categories
+
+cat1, cat2
 
 ## Summary
 
@@ -120,11 +161,10 @@ Commands are used in the Freddie Egeria markdown language.
 
 ## Version
 
-0.2
+v1
 
 ## Status
 
-DRAFT
 
 ## Qualified Name
 
@@ -134,11 +174,16 @@ DRAFT
 
 ## Glossary Name
 
-Egeria-Markdown
+test
 
 ## Term Name
 
-Source
+t2
+
+## Categories
+Writing Markdown
+
+Processing Markdown
 
 ## Summary
 
@@ -162,7 +207,6 @@ Source of the markdown content - could be jupter or plain markdown file.
 
 DRAFT
 
-## Update Description
 
 ---
 
@@ -176,6 +220,10 @@ Egeria-Markdown
 
 Directive
 
+## Categories
+
+meow mix
+
 ## Summary
 
 A directive defines how the command is to be processed.

pyegeria/commands/cat/{freddie_jupyter.py → dr_egeria_jupyter.py}

@@ -1,28 +1,20 @@
 """
 This is an ongoing experiment in parsing and playing with Freddie docs
 """
-import json
 
-from jupyter_notebook_parser import JupyterNotebookParser
 import nbformat
 import os
-import re
-from pyegeria import EgeriaTech
-from rich import box, print
+from rich import print
 from rich.console import Console
-from rich.markdown import Markdown
-from rich.prompt import Prompt
-from rich.table import Table
-from freddie_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                        get_current_datetime_string, process_per_proj_upsert_command, commands)
+from pyegeria.md_processing_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
+                                          get_current_datetime_string, process_per_proj_upsert_command, commands)
 import click
-from pyegeria import EgeriaTech, body_slimmer, NO_GLOSSARIES_FOUND, NO_TERMS_FOUND, NO_ELEMENTS_FOUND, NO_PROJECTS_FOUND
+from pyegeria import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
+                      get_current_datetime_string, process_per_proj_upsert_command, commands,EgeriaTech
+                      )
 from pyegeria._exceptions import (
-    InvalidParameterException,
-    PropertyServerException,
     print_exception_response,
 )
-from datetime import datetime
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
 EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
@@ -44,8 +36,8 @@ EGERIA_JUPYTER = os.environ.get("EGERIA_JUPYTER", False)
 EGERIA_HOME_GLOSSARY_GUID = os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None)
 EGERIA_GLOSSARY_PATH = os.environ.get("EGERIA_GLOSSARY_PATH", None)
 EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", "/Users/dwolfson/localGit/egeria-v5-3/egeria-python")
-EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/freddies-inbox")
-EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/freddies-outbox")
+EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/dr_egeria_inbox")
+EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/dr_egeria_outbox")
 
 console = Console(width=int(EGERIA_WIDTH))
 

pyegeria/commands/cat/{freddie_md.py → dr_egeria_md.py}

@@ -2,27 +2,19 @@
 This is an ongoing experiment in parsing and playing with Freddie docs
 """
 import json
-import mistune
-from jupyter_notebook_parser import JupyterNotebookParser
-import nbformat
 import os
-import re
-from pyegeria import EgeriaTech
-from rich import box, print
+from rich import print
 from rich.console import Console
 from rich.markdown import Markdown
-from rich.prompt import Prompt
-from rich.table import Table
-from freddie_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                        get_current_datetime_string, process_per_proj_upsert_command, commands)
+
+from pyegeria.md_processing_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
+                                          get_current_datetime_string, process_per_proj_upsert_command, commands)
 
 import click
-from pyegeria import EgeriaTech, body_slimmer, NO_GLOSSARIES_FOUND, NO_TERMS_FOUND, NO_ELEMENTS_FOUND, NO_PROJECTS_FOUND
-from pyegeria._exceptions import (
-    InvalidParameterException,
-    PropertyServerException,
-    print_exception_response,
-)
+from pyegeria import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
+                      process_categories_upsert_command,
+                      get_current_datetime_string, process_per_proj_upsert_command, commands,EgeriaTech
+                      )
 from datetime import datetime
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -45,8 +37,8 @@ EGERIA_JUPYTER = os.environ.get("EGERIA_JUPYTER", False)
 EGERIA_HOME_GLOSSARY_GUID = os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None)
 EGERIA_GLOSSARY_PATH = os.environ.get("EGERIA_GLOSSARY_PATH", None)
 EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", "/Users/dwolfson/localGit/egeria-v5-3/egeria-python")
-EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/freddies-inbox")
-EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/freddies-outbox")
+EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/dr_egeria_inbox")
+EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/dr_egeria_outbox")
 
 console = Console(width=int(EGERIA_WIDTH))
 
@@ -85,7 +77,7 @@ def process_markdown_file(
         return {}  # Return empty dict if file not found
 
     final_output = (f"\n# Results from processing file {file_path} on "
-                    f"{datetime.now().strftime("%Y-%m-%d %H:%M")}\n---\n")
+                    f"{datetime.now().strftime("%Y-%m-%d %H:%M")}\n")
     h1_blocks = []
     current_block = ""
     in_h1_block = False
@@ -120,6 +112,8 @@ def process_markdown_file(
             # Process the block based on the command
             if potential_command in ["Create Glossary", "Update Glossary"]:
                 result = process_glossary_upsert_command(client, element_dictionary, block, directive)
+            elif potential_command in ["Create Category", "Update Category"]:
+                result = process_categories_upsert_command(client, element_dictionary, block, directive)
             elif potential_command in ["Create Term", "Update Term"]:
                 result = process_term_upsert_command(client, element_dictionary, block, directive)
             elif potential_command in ["Create Personal Project", "Update Personal Project"]:
@@ -131,8 +125,8 @@ def process_markdown_file(
             if result:
                 if directive == "process":
                     updated = True
-                    final_output += f"\n---\n{result}\n---\n\n"
-                    # print(json.dumps(element_dictionary, indent=4))
+                    final_output += f"\n---\n{Markdown(result)}\n---\n\n"
+                    print(json.dumps(element_dictionary, indent=4))
             elif directive == "process":
                 # Handle case with errors (skip this block but notify the user)
                 print(f"\n==>\tErrors found while processing command: \'{potential_command}\'\n"
@@ -143,18 +137,21 @@ def process_markdown_file(
             final_output += f"\n---\n{block}\n---\n\n"
 
     # Write the final_output to a new file if updated
-    if updated:
-        path, filename = os.path.split(file_path)  # Get both parts
-        new_filename = f"processed-{get_current_datetime_string()}-{filename}"  # Create the new filename
-        new_file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH, new_filename)  # Construct the new path
-        os.makedirs(os.path.dirname(new_file_path), exist_ok=True)
-
-        with open(new_file_path, 'w') as f2:
-            f2.write(final_output)
-        click.echo(f"\n==> Notebook written to {new_file_path}")
-    else:
-        click.echo("\nNo updates detected. New File not created.")
+    try:
+        if updated:
+            path, filename = os.path.split(file_path)  # Get both parts
+            new_filename = f"processed-{get_current_datetime_string()}-{filename}"  # Create the new filename
+            new_file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH, new_filename)  # Construct the new path
+            os.makedirs(os.path.dirname(new_file_path), exist_ok=True)
+
+            with open(new_file_path, 'w') as f2:
+                f2.write(final_output)
+            click.echo(f"\n==> Notebook written to {new_file_path}")
+        else:
+            click.echo("\nNo updates detected. New File not created.")
 
+    except (Exception):
+        console.print_exception(show_locals=True)
 
 
 if __name__ == "__main__":

pyegeria/commands/cat/glossary_actions.py

@@ -259,6 +259,64 @@ 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("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)
@@ -368,7 +426,7 @@ def export_terms_csv(
 @click.option(
     "--is_root",
     help="Is this a root category?",
-    default=False,
+    default=True,
     is_flag=True,
 )
 @click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use.")

pyegeria/commands/cat/list_categories.py

@@ -0,0 +1,185 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List categories for a category.
+
+
+A simple display for category terms
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+
+from pyegeria import (
+    EgeriaTech,
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    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("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("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")
+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", "150"))
+EGERIA_category_PATH = os.environ.get("EGERIA_category_PATH", None)
+EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", "/Users/dwolfson/localGit/egeria-v5-3/egeria-python")
+EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/dr_egeria_inbox")
+EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/dr_egeria_outbox")
+
+
+
+def display_categories(
+    search_string: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    output_format: str = "TABLE",
+):
+    """Display either a specified category or all categories if the search_string is '*'.
+    Parameters
+    ----------
+    search_string : str, default is '*'
+        The string used to search for categories.
+    view_server : str
+        The view server name or address where the Egeria services are hosted.
+    view_url : str
+        The URL of the platform the view server is on.
+    user : str
+        The user ID for authentication with the Egeria server.
+    user_pass : str
+        The password for authentication with the Egeria server.
+    jupyter : bool, optional
+        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
+    width : int, optional
+        The width of the console output (default is EGERIA_WIDTH).
+    output_format: str, optional, default is 'JSON'
+        One of  FORM, REPORT, TABLE
+    """
+    m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
+    token = m_client.create_egeria_bearer_token()
+
+
+    try:
+        if output_format == "FORM":
+            action = "Update-Form"
+        elif output_format == "REPORT":
+            action = "Report"
+        if output_format != "TABLE":
+            file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH)
+            file_name = f"Categories-{time.strftime('%Y-%m-%d-%H-%M-%S')}-{action}.md"
+            full_file_path = os.path.join(file_path, file_name)
+            os.makedirs(os.path.dirname(full_file_path), exist_ok=True)
+            output = m_client.find_glossary_categories(search_string, output_format=output_format)
+            if output == "NO_CATEGORIES_FOUND":
+                print(f"\n==> No categories found for search string '{search_string}'")
+                return
+            with open(full_file_path, 'w') as f:
+                f.write(output)
+            print(f"\n==> Categories output written to {full_file_path}")
+            return
+
+        table = Table(
+            title=f"Category List @ {time.asctime()}",
+            style="bright_white on black",
+            header_style="bright_white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
+            expand=True,
+        )
+        table.add_column("Category Name")
+        table.add_column(
+            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
+        )
+        table.add_column("Description")
+        table.add_column("In Glossary (Qualified Name)")
+
+        categories = m_client.find_glossary_categories(search_string)
+        if type(categories) is list:
+            sorted_category_list = sorted(
+                categories, key=lambda k: k["glossaryCategoryProperties"]["displayName"]
+            )
+            for category in sorted_category_list:
+                display_name = category["glossaryCategoryProperties"].get("displayName",'---')
+                qualified_name = category["glossaryCategoryProperties"]["qualifiedName"]
+                category_guid = category["elementHeader"]["guid"]
+                q_name = Text(f"{qualified_name}\n&\n{category_guid}", justify="center")
+                description = category["glossaryCategoryProperties"].get("description",'---')
+                classification_props = category["elementHeader"]['classifications'][0].get('classificationProperties',None)
+                glossary_qualified_name = '---'
+                if classification_props is not None:
+                    glossary_guid = classification_props.get('anchorGUID','---')
+                    glossary_qualified_name = (
+                        m_client.get_glossary_by_guid(glossary_guid))['glossaryProperties']['qualifiedName']
+
+                table.add_row(display_name, q_name, description, glossary_qualified_name)
+            console = Console(
+                style="bold bright_white on black",
+                width=width,
+                force_terminal=not jupyter,
+            )
+            console.print(table)
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        search_string = Prompt.ask(
+            "Enter the category you are searching for or '*' for all:", default="*"
+        )
+        output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "FORM", "REPORT"],
+                                   default="TABLE")
+
+        display_categories(search_string, server, url, userid,
+                           user_pass, output_format = output_format)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()