pyegeria 5.3.6.1__tar.gz → 5.3.6.2__tar.gz

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyegeria
-Version: 5.3.6.1
+Version: 5.3.6.2
 Summary: A python client for Egeria
 License: Apache 2.0
 Keywords: egeria,metadata,governance

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cat/freddie_utils.py

@@ -518,7 +518,7 @@ def process_per_proj_upsert_command(egeria_client: EgeriaTech, element_dictionar
                 msg += f"* {ERROR}Project {project_name} does not exist\n"
                 valid = False
             if len(project_details) > 1 and project_exists:
-                msg += f"* {ERROR}More than one projecty with name {project_name} found\n"
+                msg += f"* {ERROR}More than one project with name {project_name} found\n"
                 valid = False
             if len(project_details) == 1:
                 known_guid = project_details[0]['elementHeader'].get('guid', None)

pyegeria-5.3.6.2/pyegeria/commands/cat/freddies-outbox/Terms-2025-03-06-13-19-29-Report.md

@@ -0,0 +1,69 @@
+# Glossaries Report - created at 2025-03-06 13:19
+Glossaries found from the search string:  `All Glossaries`
+
+# Glossary Name: Egeria-Markdown
+
+## Description
+Glossary to describe the vocabulary of Freddie - an Egeria Markdown language to support the exchange of metadata in a Markdown form.
+Freddie allows users to input metadata using any text entry system that supports the entry of standard Markdown characters and through post-processing
+commands, validates the Egeria content and allows the requests to be sent to Egeria. This is an update
+
+## Language
+English
+
+## 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.
+5) anything?
+
+## Qualified Name
+Glossary:Egeria-Markdown
+
+## GUID
+5d45b499-d0d5-4fad-bc23-763bc4073296
+
+
+---
+
+# Glossary Name: Teddy Bear Drop Foot Terminology
+
+## Description
+This glossary describes terminology invented for the fictitious study into Teddy Bear Drop Foot that is being used to demonstrate aspects of open governance without risk to real patient data. 
+
+## Language
+English
+
+## Usage
+Used with the Teddy Bear Drop Foot Demonstration Study.
+
+## Qualified Name
+Glossary:TeddyBearDropFootTerminology
+
+## GUID
+c103d0c9-7581-47e1-a684-6bbe0ecd596f
+
+
+---
+
+# Glossary Name: Sustainability Glossary
+
+## Description
+Terminology associated with Coco Pharmaceutical's sustainability initiative.
+
+## Language
+English
+
+## Usage
+For all Coco Pharmaceutical employees wishing to understand more about sustainability and the organization's efforts to improve its operations.
+
+## Qualified Name
+Glossary:Sustainability
+
+## GUID
+30bfe79e-adf2-4fda-b9c5-9c86ad6b0d6c
+
+
+---
+

pyegeria-5.3.6.2/pyegeria/commands/cat/freddies-outbox/Terms-2025-03-06-13-20-30-Update-Form.md

@@ -0,0 +1,78 @@
+# Update Glossaries Form - created at 2025-03-06 13:20
+Glossaries found from the search string:  `All Glossaries`
+
+# Update Glossary
+
+## Glossary Name 
+Egeria-Markdown
+
+## Description
+Glossary to describe the vocabulary of Freddie - an Egeria Markdown language to support the exchange of metadata in a Markdown form.
+Freddie allows users to input metadata using any text entry system that supports the entry of standard Markdown characters and through post-processing
+commands, validates the Egeria content and allows the requests to be sent to Egeria. This is an update
+
+## Language
+English
+
+## 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.
+5) anything?
+
+## Qualified Name
+Glossary:Egeria-Markdown
+
+## GUID
+5d45b499-d0d5-4fad-bc23-763bc4073296
+
+
+---
+
+# Update Glossary
+
+## Glossary Name 
+Teddy Bear Drop Foot Terminology
+
+## Description
+This glossary describes terminology invented for the fictitious study into Teddy Bear Drop Foot that is being used to demonstrate aspects of open governance without risk to real patient data. 
+
+## Language
+English
+
+## Usage
+Used with the Teddy Bear Drop Foot Demonstration Study.
+
+## Qualified Name
+Glossary:TeddyBearDropFootTerminology
+
+## GUID
+c103d0c9-7581-47e1-a684-6bbe0ecd596f
+
+
+---
+
+# Update Glossary
+
+## Glossary Name 
+Sustainability Glossary
+
+## Description
+Terminology associated with Coco Pharmaceutical's sustainability initiative.
+
+## Language
+English
+
+## Usage
+For all Coco Pharmaceutical employees wishing to understand more about sustainability and the organization's efforts to improve its operations.
+
+## Qualified Name
+Glossary:Sustainability
+
+## GUID
+30bfe79e-adf2-4fda-b9c5-9c86ad6b0d6c
+
+
+---
+

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cat/list_glossaries.py

@@ -43,6 +43,11 @@ 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_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_FREDDIE_INBOX_PATH = os.environ.get("EGERIA_FREDDIE_INBOX_PATH", "pyegeria/commands/cat/freddies-inbox")
+EGERIA_FREDDIE_OUTBOX_PATH = os.environ.get("EGERIA_FREDDIE_OUTBOX_PATH", "pyegeria/commands/cat/freddies-outbox")
+
 
 
 def display_glossaries(
@@ -53,6 +58,8 @@ def display_glossaries(
     user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
+    md: bool = False,
+    form: bool = False,
 ):
     """Display either a specified glossary or all glossaries if the search_string is '*'.
     Parameters
@@ -71,10 +78,36 @@ def display_glossaries(
         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).
+    md: bool, [default=False]
+        If true, a simplified markdown report of the glossaries will be created. Filename is Glossaries-<DATE>-<ACTION>
+        The filepath is derived from the environment variables EGERIA_ROOT_PATH and EGERIA_FREDDIE_OUTPUT_PATH, respectively.
+    form: bool, [default=False]
+        If true and md is true, a form for the glossaries will be created as a markdown file.
+        If false and md is true, a markdown report for the glossaries will be created.
     """
     m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     token = m_client.create_egeria_bearer_token()
+
+
     try:
+        if md:
+            if form:
+                action = "Update-Form"
+            else:
+                action = "Report"
+            file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_FREDDIE_OUTBOX_PATH)
+            file_name = f"Glossaries-{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_glossaries(search_string, md=md, form=form)
+            if output == "NO_GLOSSARIES_FOUND":
+                print(f"\n==> No glossaries found for search string '{search_string}'")
+                return
+            with open(full_file_path, 'w') as f:
+                f.write(output)
+            print(f"\n==> Glossaries output written to {full_file_path}")
+            return
+
         table = Table(
             title=f"Glossary List @ {time.asctime()}",
             style="bright_white on black",
@@ -139,8 +172,14 @@ def main():
         search_string = Prompt.ask(
             "Enter the glossary you are searching for or '*' for all:", default="*"
         )
+        mdq = Prompt.ask("Do you want to create a markdown report?", choices=["y", "n"], default="n")
+        md = True if mdq.lower() == "y" else False
+
+        formq = Prompt.ask("Do you want to create a form?", choices=["y", "n"], default="n")
+        form = True if formq.lower() == "y" else False
 
-        display_glossaries(search_string, server, url, userid, user_pass)
+        display_glossaries(search_string, server, url, userid,
+                           user_pass, md = md, form = form)
 
     except KeyboardInterrupt:
         pass

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cat/list_terms.py

@@ -43,7 +43,10 @@ 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_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_FREDDIE_INBOX_PATH = os.environ.get("EGERIA_FREDDIE_INBOX_PATH", "pyegeria/commands/cat/freddies-inbox")
+EGERIA_FREDDIE_OUTBOX_PATH = os.environ.get("EGERIA_FREDDIE_OUTBOX_PATH", "pyegeria/commands/cat/freddies-outbox")
 
 
 def display_glossary_terms(
@@ -56,6 +59,8 @@ def display_glossary_terms(
     user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
+    md: bool = False,
+    form: bool = False,
 ):
     """Display a table of glossary terms filtered by search_string and glossary, if specified. If no
         filters then all terms are displayed. If glossary_guid or name is specified, then only terms from that
@@ -84,6 +89,12 @@ def display_glossary_terms(
         Flag to indicate if the output should be formatted for Jupyter notebook. Defaults to EGERIA_JUPYTER.
     width : int
         The width of the console output. Defaults to EGERIA_WIDTH.
+    md: bool, [default=False]
+        If true, a simplified markdown report of the terms will be created. Filename is Terms-<DATE>-<ACTION>
+        The filepath is derived from the environment variables EGERIA_ROOT_PATH and EGERIA_FREDDIE_OUTPUT_PATH, respectively.
+    form: bool, [default=False]
+        If true and md is true, a form for the terms will be created as a markdown file.
+        If false and md is true, a markdown report for the terms will be created.
     """
 
     console = Console(
@@ -101,6 +112,34 @@ def display_glossary_terms(
     elif (glossary_guid is not None) and (len(glossary_guid) < 10):
             glossary_guid = None
 
+    if md:
+        if form:
+            action = "Update-Form"
+        else:
+            action = "Report"
+        try:
+            file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_FREDDIE_OUTBOX_PATH)
+            file_name = f"Terms-{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 = g_client.find_glossaries(search_string, md=md, form=form)
+            if output == "NO_TERMS_FOUND":
+                print(f"\n==> No terms found for search string '{search_string}'")
+                return
+            with open(full_file_path, 'w') as f:
+                f.write(output)
+            print(f"\n==> Terms output written to {full_file_path}")
+            return
+        except (
+            InvalidParameterException,
+            PropertyServerException,
+            UserNotAuthorizedException,
+            ) as e:
+            console.print_exception()
+        finally:
+            g_client.close_session()
+
+
     def generate_table(search_string: str, glossary_guid: str) -> Table:
         """Make a new table."""
         table = Table(
@@ -234,8 +273,16 @@ def main():
             "Enter the name of the glossary to search or '*' for all glossaries:",
             default="*",
         )
+
+        mdq = Prompt.ask("Do you want to create a markdown report?", choices=["y", "n"], default="n")
+        md = True if mdq.lower() == "y" else False
+
+        formq = Prompt.ask("Do you want to create a form?", choices=["y", "n"], default="n")
+        form = True if formq.lower() == "y" else False
+
         display_glossary_terms(
-            search_string, guid, glossary_name, server, url, userid, user_pass
+        search_string, guid, glossary_name, server, url,
+            userid, user_pass, md = md, form = form
         )
 
     except KeyboardInterrupt:

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cli/egeria.py

@@ -211,6 +211,19 @@ from pyegeria.commands.tech.list_valid_metadata_values import display_metadata_v
     default=os.environ.get("EGERIA_GLOSSARY_PATH", "/home/jovyan/loading-bay/glossary"),
     help="Path to glossary import/export files",
 )
+
+@click.option(
+    "--inbox_path",
+    default=os.environ.get("EGERIA_ROOT_PATH", "/home/jovyan"),
+    help="Path to inbox files",
+)
+
+@click.option(
+    "--outbox_path",
+    default=os.environ.get("EGERIA_FREDDIE_OUTBOX_PATH", "distribution-hub/freddies-outbox"),
+    help="Path to outbox files",
+)
+
 @click.pass_context
 def cli(
     ctx,
@@ -231,6 +244,9 @@ def cli(
     width,
     home_glossary_guid,
     glossary_path,
+    inbox_path,
+    outbox_path,
+
 ):
     """An Egeria Command Line interface for Operations"""
     ctx.obj = Config(
@@ -251,6 +267,8 @@ def cli(
         width,
         home_glossary_guid,
         glossary_path,
+        inbox_path,
+        outbox_path
     )
     ctx.max_content_width = 250
     ctx.ensure_object(Config)
@@ -1114,8 +1132,20 @@ def glossary_group(ctx):
     default="*",
     help="Optionally restrict search to a specific named glossary",
 )
+@click.option(
+    "--markdown",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list in markdown format",
+    )
+@click.option(
+    "--form",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list as an update form",
+    )
 @click.pass_context
-def show_terms(ctx, search_string, glossary_guid, glossary_name):
+def show_terms(ctx, search_string, glossary_guid, glossary_name, md, form):
     """Find and display glossary terms"""
     c = ctx.obj
     display_glossary_terms(
@@ -1128,6 +1158,8 @@ def show_terms(ctx, search_string, glossary_guid, glossary_name):
         c.password,
         c.jupyter,
         c.width,
+        md,
+        form,
     )
 
 
@@ -1685,8 +1717,20 @@ def databases(ctx):
 
 @glossary_group.command("glossaries")
 @click.option("--search_string", default="*", help="Name to search for glossaries")
+@click.option(
+    "--markdown",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list in markdown format",
+    )
+@click.option(
+    "--form",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list as an update form",
+    )
 @click.pass_context
-def glossaries(ctx, search_string):
+def glossaries(ctx, search_string, md, form):
     """Display a list of glossaries"""
     c = ctx.obj
     display_glossaries(
@@ -1697,6 +1741,8 @@ def glossaries(ctx, search_string):
         c.password,
         c.jupyter,
         c.width,
+        md,
+        form
     )
 
 

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cli/egeria_cat.py

@@ -325,8 +325,20 @@ def glossary_group(ctx):
     default="*",
     help="Optionally restrict search to a specific named glossary",
 )
+@click.option(
+    "--markdown",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list in markdown format",
+    )
+@click.option(
+    "--form",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list as an update form",
+    )
 @click.pass_context
-def show_terms(ctx, search_string, glossary_guid, glossary_name):
+def show_terms(ctx, search_string, glossary_guid, glossary_name, md, form):
     """Find and display glossary terms"""
     c = ctx.obj
     display_glossary_terms(
@@ -339,13 +351,27 @@ def show_terms(ctx, search_string, glossary_guid, glossary_name):
         c.password,
         c.jupyter,
         c.width,
+        md,
+        form,
     )
 
 
 @glossary_group.command("glossaries")
 @click.option("--search_string", default="*", help="Name to search for glossaries")
+@click.option(
+    "--markdown",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list in markdown format",
+    )
+@click.option(
+    "--form",
+    flag_value=True,
+    default=False,
+    help="Optionally display glossary list as an update form",
+    )
 @click.pass_context
-def glossaries(ctx, search_string):
+def glossaries(ctx, search_string, md, form):
     """Display a list of glossaries"""
     c = ctx.obj
     display_glossaries(
@@ -356,6 +382,8 @@ def glossaries(ctx, search_string):
         c.password,
         c.jupyter,
         c.width,
+        md,
+        form,
     )
 
 

{pyegeria-5.3.6.1 → pyegeria-5.3.6.2}/pyegeria/commands/cli/ops_config.py

@@ -21,6 +21,8 @@ class Config(object):
         width: int,
         home_glossary_guid: str,
         glossary_path: str,
+        inbox_path: str,
+        outbox_path: str
     ):
         self.metadata_store = server
         self.metadata_store_url = url
@@ -41,6 +43,8 @@ class Config(object):
         self.url = url
         self.home_glossary_guid = home_glossary_guid
         self.glossary_path = glossary_path
+        self.inbox_path = inbox_path
+        self.outbox_path = outbox_path
 
 
 pass_config = click.make_pass_decorator(Config)