pyegeria 5.3.5.3__py3-none-any.whl → 5.3.6.2__py3-none-any.whl

pyegeria/commands/cat/glossary_creation_experiment.ipynb

@@ -0,0 +1,235 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f211c1736f87555",
+   "metadata": {},
+   "source": [
+    "# This notebook contains experimental Freddie commands\n",
+    "## Lets see if this is parsed\n",
+    "meow"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3b321563-4977-496a-963b-9b9dd75de968",
+   "metadata": {},
+   "source": [
+    "# Create Glossary\n",
+    "## Glossary Name\n",
+    "\n",
+    "Egeria-Markdown\n",
+    "\n",
+    "## Language\n",
+    "English\n",
+    "\n",
+    "## Description\n",
+    "\n",
+    "Glossary to describe the vocabulary of Freddie - an Egeria Markdown language to support the exchange of metadata in a Markdown form.\n",
+    "Freddie allows users to input metadata using any text entry system that supports the entry of standard Markdown characters and through post-processing\n",
+    "commands, validates the Egeria content and allows the requests to be sent to Egeria.\n",
+    "\n",
+    "\n",
+    "## Usage\n",
+    "1) (optional) load an example or template for the type of object from Egeria.\n",
+    "2) Create a new document (perhaps from the template) and edit it, adding in the content with the Freddie controlled Markdown language.\n",
+    "3) Process the document to validate and display it before you submit it, Validation may annotate your document with recommendations and potential issues.\n",
+    "4) Submit the document to Egeria using the Freddie_sings command.\n",
+    "\n",
+    "## <Qualified Name>\n",
+    "\n",
+    "## <GUID>\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a7295df2-5afb-46ba-889a-94881d883678",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:23:58.820592Z",
+     "iopub.status.busy": "2025-02-27T15:23:58.820416Z",
+     "iopub.status.idle": "2025-02-27T15:24:00.802861Z",
+     "shell.execute_reply": "2025-02-27T15:24:00.802425Z",
+     "shell.execute_reply.started": "2025-02-27T15:23:58.820583Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "%pip install jupyter-notebook-parser\n",
+    "%pip install marko"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d02383df-f617-48f7-be54-e930b6275a7e",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:25:33.155175Z",
+     "iopub.status.busy": "2025-02-27T15:25:33.154695Z",
+     "iopub.status.idle": "2025-02-27T15:25:33.162801Z",
+     "shell.execute_reply": "2025-02-27T15:25:33.162362Z",
+     "shell.execute_reply.started": "2025-02-27T15:25:33.155158Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "import json\n",
+    "import marko\n",
+    "from jupyter_notebook_parser import JupyterNotebookParser"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b5560fcd-afe4-4133-8204-8f2535feb9b6",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:25:34.354443Z",
+     "iopub.status.busy": "2025-02-27T15:25:34.354300Z",
+     "iopub.status.idle": "2025-02-27T15:25:34.358702Z",
+     "shell.execute_reply": "2025-02-27T15:25:34.358236Z",
+     "shell.execute_reply.started": "2025-02-27T15:25:34.354435Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "parsed = JupyterNotebookParser('glossary_creation_experiment.ipynb')\n",
+    "\n",
+    "parsed.get_all_cells()  # returns List[Dict], each Dict is a notebook cell\n",
+    "\n",
+    "cells = parsed.get_markdown_cells()  # returns List[Dict], each Dict is a markdown cel\n",
+    "indices = parsed.get_markdown_cell_indices()  # returns List[int], each is a markdown cell's index\n",
+    "cell_sources = parsed.get_markdown_cell_sources()  # returns List[str], each is a markdown cell's text\n",
+    "print(json.dumps(cell_sources, indent = 4))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "79dffa96-7e2a-40e3-a0d7-ba363d87b70c",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:42:47.354237Z",
+     "iopub.status.busy": "2025-02-27T15:42:47.353238Z",
+     "iopub.status.idle": "2025-02-27T15:42:47.360634Z",
+     "shell.execute_reply": "2025-02-27T15:42:47.360090Z",
+     "shell.execute_reply.started": "2025-02-27T15:42:47.354193Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "parsed_markdown = marko.parse(cell_sources[0])\n",
+    "print(type(parsed_markdown))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f3d66578-cf02-4e95-a102-f84fbe3aae95",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:44:51.000320Z",
+     "iopub.status.busy": "2025-02-27T15:44:51.000168Z",
+     "iopub.status.idle": "2025-02-27T15:44:51.007790Z",
+     "shell.execute_reply": "2025-02-27T15:44:51.007211Z",
+     "shell.execute_reply.started": "2025-02-27T15:44:51.000309Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "parsed_source = marko.parse_source(cell_sources[0])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7cc1a99c-46b3-42c9-8b38-77fb721586a7",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-02-27T15:45:28.853162Z",
+     "iopub.status.busy": "2025-02-27T15:45:28.852948Z",
+     "iopub.status.idle": "2025-02-27T15:45:28.856556Z",
+     "shell.execute_reply": "2025-02-27T15:45:28.856159Z",
+     "shell.execute_reply.started": "2025-02-27T15:45:28.853153Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "? marko"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ca5f9660-1f56-4de9-8127-5e7e4a922b5f",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e967897d83588f86",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ed29f0e5d46a7c20",
+   "metadata": {},
+   "source": [
+    "# Create Glossary\n",
+    "## Glossary Name\n",
+    "\n",
+    "Another Test\n",
+    "\n",
+    "## Language\n",
+    "English\n",
+    "\n",
+    "## Description\n",
+    "\n",
+    "Another quick test\n",
+    "\n",
+    "## Usage\n",
+    "Alternate sundays\n",
+    "\n",
+    "## <Qualified Name>\n",
+    "\n",
+    "## <GUID>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e36a5074b9a94c1a",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

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/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/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/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/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)