pyegeria 5.3.6.2.5__py3-none-any.whl → 5.3.6.4__py3-none-any.whl

pyegeria/commands/cat/freddies-inbox/freddie_intro.md

@@ -1,221 +0,0 @@
-# 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.
-
-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
-tools and approaches people already use. And maybe even make their day job a little
-easier.
-
-So this is what we are exploring with Freddie. An Egeria Markdown language that allows
-users to intermix requests to Egeria with other text through the use of standard Markdown.
-
-This file is an example. You will see that we intersperse normal narrative text (such as this)
-with Commands to Egeria. We introduce a specific vocabulary to make Egeria requests.
-
-In the example below we will create a new Egeria glossary to hold definitions related to Freddie:
----
-
-# Create Glossary
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Language
-
-English
-
-## 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
-
-## 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.
-
-## <Qualified Name>
-
-## <GUID>
-
----
-
-# First Walk-Through
-The block of markdown above is a request to create a new Egeria Glossary called `Egeria-Markdown`. Let's briefly walk
-through. The command starts when we see `# Create Glossary`. This is a known phrase in Freddie. When we see this 
-phrase we recognize that this is an egeria markdown request block. The request block ends if we encounter another `#` or
-`---`, or run out of text. Within this request block we note some **attributes** that begin with a `## `. The first that
-we encounter is `## Glossary Name`. Not all attributes need to be filled in. Later, we'll process this file and demonstrate 
-how to tell - but first, lets look at the attributes shown:
-
-* `## Glossary Name` - this is the display name of the glossary. In this case the name is `Egeria-Markdown` As you can 
-see, the value of the attribute is the plain text that follows it.
-* `## Language` - what language will the terms of the glossary be in (yes there are ways to have mixed language but
-Freddie strives to be as simple as possible).
-* `## Description` - a description of the glossary and its purpose.
-* `## Usage` - how the glossary is meant to be used and by whom.
-* `## <Qualified Name>` - every element in Egeria must have a unique qualified name that we use to distinguish 
-it from all other elements. The qualified name is meant to be understandable by humans, although it may follow 
-formatting conventions. This attributes is in angle brackets because at this point we can't fill it in - we are just
-in the midst of creating the glossary. A qualified name will be created for us as part of the glossary creation. We'll
-see a little later how we get that.
-* `## <GUID>` - same story as qualified name except that this is meant for automation and not people.
-
-And that's it. That's all we need to do to specify the creation of a new glossary (well - mostly - we'll reveal a few 
-more details a bit later).
-
-## Great! That was easy!
-
-We now have a nice, clean, new...and empty...glossary - guess we better start filling it. Lets create a couple of terms.
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Command
-
-## Summary
-
-Commands are how a user of the Freddie markdown language requests an action.
-
-## Description
-
-Commands are how a user can request Egeria to take an action such as Create or Update an Egeria element. Freddie
-provides
-a limited (but growing) set of commands. Freddie commands align with the pyegeria 'hey-egeria' command line interface.
-
-## Abbreviation
-
-## Examples
-
-Create Glossary or
-Update Glossary or
-Create Term or
-Update Term
-
-## Usage
-
-Commands are used in the Freddie Egeria markdown language.
-
-## Version
-
-0.2
-
-## Status
-
-DRAFT
-
-## Qualified Name
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Source
-
-## Summary
-
-Source of the markdown content.
-
-## Description
-
-Source of the markdown content - could be jupter or plain markdown file.
-
-## Abbreviation
-
-## Examples
-
-## Usage
-
-## Version
-
-0.1
-
-## Status
-
-DRAFT
-
-## Update Description
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Directive
-
-## Summary
-
-A directive defines how the command is to be processed.
-
-## Description
-
-Directives are one of:
-
-* display - just display what we've found
-* validate - check the validity of the requested action
-* process - process the requested action
-
-## Abbreviation
-
-## Examples
-
-## Usage
-
-## Version
-
-0.1
-
-## Status
-
-DRAFT
-
----
-
-# Some terms specified - Now what?
-
-Ok - we've now created a glossary and three terms to go into the glossary. Here is what we'll do next.
-
->Note: This is changing - so will be somewhat abstrct
-
-We will run a small program called freddie_md.py to operate on this markdown file. When we run this program we 
-tell it not just the name of the file to process but also provide a directive on what to do. Currently we have the 
-choice of:
-
-1. Display - just parse the file, breaking it down into request blocks, and display what we find
-2. Validate - parse the file and validate if the commands can be processed - showing information about what we observe.
-3. Process - parse the request blocks and execute the commands - and produce a new output file to simplify further processing.
-
-# Great --> let's give it a try!

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

@@ -1,69 +0,0 @@
-# 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/commands/cat/freddies-outbox/Terms-2025-03-06-13-20-30-Update-Form.md

@@ -1,78 +0,0 @@
-# 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/commands/cat/freddies-outbox/Terms-2025-03-06-19-39-25-Update-Form.md

@@ -1,78 +0,0 @@
-# Update Glossaries Form - created at 2025-03-06 19:39
-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/commands/cat/glossary_creation_experiment.ipynb

@@ -1,235 +0,0 @@
-{
- "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
-}