pyegeria 5.4.0.dev3__py3-none-any.whl → 5.4.0.dev5__py3-none-any.whl

md_processing/dr_egeria_inbox/archive/freddie_intro.md

@@ -1,284 +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 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
-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
-
-test
-
-## 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
-
-a quick test glossary
-## <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 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
-
-test
-
-## Term Name
-
-t1
-
-## Categories
-
-cat1, cat2
-
-## 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
-
-v1
-
-## Status
-
-
-## Qualified Name
-
----
-
-# Create Term
-
-## Glossary Name
-
-test
-
-## Term Name
-
-t2
-
-## Categories
-Writing Markdown
-
-Processing Markdown
-
-## 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
-
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Directive
-
-## Categories
-
-meow mix
-
-## 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!
-
-Ok - its processed the file and generated output to the console that shows us what it has done.
-We also now have a new file in the designated outbox (specified by an Environment Variable).
-If we review that file, we see that it has similar content to this original file except that
-the **Create** statements have been replaced with **Update** statements and
-attributes such as **Qualified Naame** and **GUID** now contain the known values.
-
-This means that if we want to make changes to the definitions that we have 
-created, all we need to do is to make changes to the updatable attributes in this
-new document and resubmit it - pretty simple.
-
-In the next section we'll see how we can update and extend what we have done by creating
-some glossary categories and then assigning categories to the terms.
-To do this we will copy the output document that we just created and call the 
-copy 

md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md

@@ -1,275 +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 Category
-
-## Category Name
-
-Writing Markdown
-
-## Owning Glossary
-
-Egeria-Markdown
-
-## Description
-
-These terms describe features of writing markdown files that can use Egeria-Markdown
-
-
-## <Qualified Name>
-
-## <GUID>
-
----
-
-# Create Category
-
-## Category Name
-
-Processing Markdown
-
-## Owning Glossary
-
-Egeria-Markdown
-
-## Description
-
-These terms describe concepts related to processing Egeria-Markdown
-
-
-## <Qualified Name>
-
-## <GUID>
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Command
-
-## Categories
-
-Processing Markdown
-
-## 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
-
-
-
-## Status
-
-
-## Qualified Name
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Source
-
-## Categories
-Writing Markdown
-
-Processing Markdown
-
-## 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
-
-
----
-
-# Create Term
-
-## Glossary Name
-
-Egeria-Markdown
-
-## Term Name
-
-Directive
-
-## Categories
-
-meow mix, Processing Markdown
-
-## 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!

md_processing/dr_egeria_inbox/archive/test-term.md

@@ -1,110 +0,0 @@
-
-# Update Term
-
-## Term Name 
-
-Command
-
-## Summary
-Commands are how a user of the Freddie markdown language requests an action.
-
-## Status
-DRAFT
-
-## 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.
-
-## Examples
-Create Glossary or
-Update Glossary or
-Create Term or
-Update Term
-
-## Usage
-Commands are used in the Freddie Egeria markdown language. updated
-
-## Qualified Name
-PDR:Term:Command
-
-## Guid
-9015183f-7357-43c8-859d-2006ae8b763e
-
-
----
-
-
----
-
-# Update Term
-
-## Term Name 
-
-Source
-
-## Summary
-Source of the markdown content.
-
-## Status
-ACTIVE
-
-## Description
-Source of the markdown content - could be jupter or plain markdown file.
-
-## Qualified Name
-PDR:Term:Source
-
-## Guid
-55dcb682-2cd3-472f-8835-a14b1fcbd1c9
-
-
----
-
-
----
-
-# Update Term
-
-## Term Name 
-
-Directive
-
-## Summary
-A directive defines how the command is to be processed.
-
-## Status
-DRAFT
-
-## 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
-
-## Qualified Name
-PDR:Term:Directive
-
-## Guid
-1ba5fafd-8424-438a-953c-9325fa5a080d
-
----
-
-# Create Term
-
-## Term Name 
-
-Directive
-
-## Summary
-A directive defines how the command is to be processed.
-
-## Status
-DRAFT
-
-## Description
-A second description
-
-## Qualified Name
-PDR:Term:Directive2