From 74eb2f40f34d20c1f4c764b69c34be14c0ddfae5 Mon Sep 17 00:00:00 2001 From: Dan Wolfson Date: Fri, 28 Jun 2024 07:12:45 -0500 Subject: [PATCH] Added a few straggling files Signed-off-by: Dan Wolfson --- .gitignore | 2 + site/docs/release-notes/june-2024.md | 2 +- .../python-widgets/overview.md | 61 +++++++++++++++++++ 3 files changed, 64 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c09139bdb6..5fbfb37e84 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,8 @@ # IntelliJ files .idea *.iml +get-pip.py +venv/** # DrawIO temporary files *.dtmp diff --git a/site/docs/release-notes/june-2024.md b/site/docs/release-notes/june-2024.md index b165b1dfb5..5e6b3c3c7f 100644 --- a/site/docs/release-notes/june-2024.md +++ b/site/docs/release-notes/june-2024.md @@ -55,7 +55,7 @@ As a result of working with this type of data, we have extended the [Open Metada ## Egeria Explorers -Egeria has a new graphical website for exploring [the open metadata types](https://app.thebrain.com/brain/fd306922-159f-4986-a6bc-111402be51f3/84fc92f5-0aa5-46f4-bb4d-0072f6b2634d). +Egeria has a new graphical website for exploring [the open metadata types](https://app.thebrain.com/brain/40c32423-60ae-4418-b305-e0a73adb0463/fd73921f-87fb-5a60-82d6-5ab421a5ed39). This website is built form [the brain](https://www.thebrain.com/) technology. Thank you to [Pragmatic Data Research Ltd](https://pdr-associates.com/) for hosting the website. diff --git a/site/docs/user-interfaces/python-widgets/overview.md b/site/docs/user-interfaces/python-widgets/overview.md index 5bf05a3c1b..4da7c3262b 100644 --- a/site/docs/user-interfaces/python-widgets/overview.md +++ b/site/docs/user-interfaces/python-widgets/overview.md @@ -3,5 +3,66 @@ # Python Widgets +The Python Widgets are a collection of examples that provide some simple but useful visualization of an Egeria environment. They +are built with the **Rich** python package and demonstrate the use of **pyegeria** . They are installed with pyegeria +python client and may be used either as python scripts or called directly. The source code for the widgets can be found +in the pyegeria github repository at [Pyegeria Widgets](https://github.com/odpi/egeria-python/tree/690e3689a749c5de148087c626b2f5712085c9b0/examples/widgets). + +As the number of widgets has grown, they have been organized by role into different sub-directories within the pyegeria distribution. + +* catalog_user - for users of the Egeria environment +* developer - for those building with, or working on Egeria +* operational - for visualizing the current state of Egeria - typically for administrators +* personal_organizer - for visualizing work and individual items + +The naming convention for the widgets helps to understand their behaviour. +When the widget starts with: + +* get - it will return details about a single item +* list - lists elements through a paging interface like "more" - use q to quit. +* view - provides a live view - typically of a status - use control-c to quit + +## Installation +The **pyegeria** Egeria Python client can be installed from **pypi** . Python version 3.10 and above is a pre-requisite. +One common way to install Python packages is with the **pip** command. So to install **pyegeria** you can execute: + +`pip install pyegeria` + +This will install **pyegeria** and all of its required packages. + +## Using + +Once **pyegeria** is installed. The widgets may be invoked from a terminal window or shell either as a command or as a python script. +To start a widget as a command, just type its full name at the command prompt. For instance, typing: + +`view_platform_status.py` + +Will display a table showing the status of all running Egeria OMAG Server platforms. + +![view_platform_status.png](view_platform_status.png) + + +Widgets can also be invoked directly if you are in the same folder as the widget (or the widgets are on the python search path). + +`python3 view_platform_status.py` + +All of the widgets have optional command line arguments. You can see them by setting the `--h` help flag. + +![widget help](widget-help.png) + +Most of the widgets allow you to specify an Egeria OMAG Platform, Server (usually a view server), and user identity. +If not specified, default values will use the Egeria default configuration with: + +* platform = "https://localhost:9443" +* server = "view-server" +* user id = a user, such as **erinoverview** from the ficticious [Coco Pharmaceuticals](https://egeria-project.org/practices/coco-pharmaceuticals/) environment. + + + + + +---- +License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), +Copyright Contributors to the Egeria project. --8<-- "snippets/abbr.md" \ No newline at end of file