Skip to content

Dr.Egeria ‐ An Egeria Markdown Language

Dan Wolfson edited this page Apr 24, 2025 · 1 revision

Overview

Dr.Egeria is an Egeria markdown language and commands that allow users to write text based markdown to exchange information with Egeria.

Dr.Egeria supports business and technical users, making it simple to both collaborate and share information as well as exchange information with Egeria. Dr. Egeria markdown can be embedded in both plain text files as well as Jupyter Notebooks. Dr.Egeria markdown commands can be interspersed with other text, meaning that Dr.Egeria markdown can be part of a broader narrative flow for a wide range of documents such as Policy documents, Design Documents or even experiments and analyses performed in Jupyter notebooks. Three short videos demonstrate some basic Dr. Egeria Capabilities. The videos demonstrate how we can use Dr.Egeria to create a business glossary and terms that document concepts and commands of Dr.Egeria. They can be be found at:

Dr.Egeria is a work-in-progress. We are quickly extending its capabilities and features - and learning along the way. We very much welcome your thoughts and feedback.

Code

Dr. Egeria is part of the pyegeria project of the Egeria Project. The code is in the pyegeria repo pyegeria. pyegeria is also available from pypi. As Dr.Egeria, hey_egeria and the base pyegeria classes are all growing rapidly, the repo will be undergoing some refactoring to improve modularity and extendibility. Please reach out with questions.

Getting Started

The videos above are a good way to get started. The easiest way to get going is to use Egeria-Workspaces. The tutorial markdown files can be found by following the path exchange/loading-bay/dr-egeria-inbox within the Egeria-Workspaces repo.

Moving forward

Currently Dr.Egeria supports about 20 different commands, most of them supporting the development of Business Glossaries. Development work to support Egeria's extensive data dictionary and data design capabilities is underway Data Designer. There is much more to document so expect to see more samples and wiki pages demonstrating Dr.Egeria.

Clone this wiki locally