pyegeria 5.3.3.13.dev3__tar.gz → 5.3.3.14__tar.gz

{pyegeria-5.3.3.13.dev3 → pyegeria-5.3.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyegeria
-Version: 5.3.3.13.dev3
+Version: 5.3.3.14
 Summary: A python client for Egeria
 License: Apache 2.0
 Keywords: egeria,metadata,governance

pyegeria-5.3.3.14/pyegeria/commands/cat/link-check.py

@@ -0,0 +1,185 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List certification types
+
+
+A simple display for certification types
+"""
+import argparse
+import os
+import sys
+import time
+import json
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.markdown import Markdown
+from rich.table import Table
+from rich.text import Text
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AssetCatalog,
+    ClassificationManager,
+)
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("EGERIA_VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+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"))
+
+
+disable_ssl_warnings = True
+
+
+def display_certifications(
+    search_string: str,
+    server: str,
+    url: str,
+    username: str,
+    user_password: str,
+    time_out: int = 60,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
+    if (search_string is None) or ((len(search_string) < 3)) and (search_string != "*"):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = ClassificationManager(
+        server, url, user_id=username, user_pwd=user_password
+    )
+    token = g_client.create_egeria_bearer_token(username, user_password)
+
+    def generate_table(search_string: str = None) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Certifications Types  @ {time.asctime()}",
+            header_style="white on dark_blue",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+        table.add_column("Title", max_width=15)
+        table.add_column("summary")
+        table.add_column("domainID")
+        table.add_column("Unique Name", width=38)
+        table.add_column("Scope", width=38)
+        # table.add_column("Qualified Name",max_width=15)
+        table.add_column("Description",width=38)
+        table.add_column("Details")
+
+
+        certs = g_client.get_elements(search_string, page_size=100, time_out=time_out)
+        if type(certs) is str:
+            return table
+
+        for element in certs:
+            properties = element["properties"]
+            summary = properties.get("summary", "---")
+            domain = properties.get("domainIdentifier", "---")
+            unique_name = properties.get("qualifiedName", "---")
+            scope = properties.get("scope", "---")
+            description = properties.get("description", "---")
+            details = properties.get("details", "---")
+            title = properties.get("title", "---")
+            cert_guid = element["elementHeader"]["guid"]
+
+            related = g_client.get_related_elements(cert_guid)
+            if (len(related) > 0) and (type(related) is list):
+                rel_md = ""
+                for rel in related:
+                    rel_type = rel["relationshipHeader"]["type"]["typeName"]
+                    rel_element_props = rel["relatedElement"]["properties"]
+                    rel_el_md = f"* Rel Type: {rel_type}\n"
+                    for key in rel_element_props.keys():
+                        rel_el_md += f"* {key}: {rel_element_props[key]}\n"
+                    rel_md += f"----\n{rel_el_md}\n"
+            else:
+                rel_md = "---"
+
+
+            unique_name = "Visit my [link=https://www.willmcgugan.com]blog[/link]!"
+            scope = Text("[link=https://egeria-project.org]Egeria[/link]")
+            description = Markdown('[egeria]("https://egeria-project.org")')
+            details = "https://pdr-associates.com"
+            table.add_row(
+                title, summary, domain, unique_name, scope, description, details
+            )
+
+        g_client.close_session()
+
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+
+        with console.pager(styles=True):
+            console.print(generate_table(search_string), soft_wrap=True)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        console.print_exception()
+        sys.exit(1)
+
+    except ValueError as e:
+        console.print(
+            f"\n\n====> Invalid Search String - must be greater than four characters long"
+        )
+        sys.exit(1)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+    parser.add_argument("--time_out", help="Time Out")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    time_out = args.time_out if args.time_out is not None else 60
+    try:
+        # search_string = Prompt.ask("Enter an asset search string:", default="*")
+        search_string = "CertificationType"
+        display_certifications(search_string, server, url, userid, user_pass, time_out)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-5.3.3.13.dev3 → pyegeria-5.3.3.14}/pyegeria/commands/tech/list_information_supply_chains.py

@@ -104,7 +104,7 @@ def supply_chain_viewer(
                 sc_mermaid_link = f"file://:{link}"
                 # print("Visit my [link=https://www.willmcgugan.com]blog[/link]!")
                 # sc_scope = Text(f"{sc_scope}\n\t\t/\n{sc_mermaid_link}")
-                sc_scope = Text(f"{sc_scope}\n\t\t/\n[link={sc_mermaid_link}]{sc_mermaid_link}[/link]!", style="underline")
+                sc_scope = f"{sc_scope}\n\t\t/\n![{sc_mermaid_link}]({sc_mermaid_link})"
                 # sc_scope.stylize("link =" + sc_mermaid_link)
 
             table.add_row(sc_name, sc_unique_name, sc_purpose_str, sc_scope, sc_desc)

{pyegeria-5.3.3.13.dev3 → pyegeria-5.3.3.14}/pyegeria/commands/tech/list_solution_blueprints2.py

@@ -19,12 +19,14 @@ from rich.prompt import Prompt
 from rich.table import Table
 from rich.text import Text
 from rich.tree import Tree
+
+from pyegeria.mermaid_utilities import EGERIA_MERMAID_FOLDER
 from pyegeria.solution_architect_omvs import SolutionArchitect
 from pyegeria import (
     ProjectManager,
     UserNotAuthorizedException,
     PropertyServerException,
-    InvalidParameterException,
+    InvalidParameterException, save_mermaid_html,
     )
 
 from pyegeria._exceptions import (
@@ -46,7 +48,7 @@ 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", "150"))
-
+EGERIA_MERMAID_FOLDER = os.environ.get("EGERIA_MERMAID_FOLDER", "work/mermaid_graphs")
 
 def blueprint_list(
     search_string: str,
@@ -74,10 +76,10 @@ def blueprint_list(
             caption=f"View Server '{server_name}' @ Platform - {platform_url}",
             expand=True,
             )
-        table.add_column("Blueprint Name")
-        table.add_column("Qualified Name \n/\n GUID\n/\nVersion", width=38, no_wrap=False)
-        table.add_column("Description")
-        table.add_column("Solution Components")
+        table.add_column("Blueprint Name  /  Diagram Link", justify="center")
+        table.add_column("Qualified Name   /  GUID  /  Version", justify="center", width=38, no_wrap=False)
+        table.add_column("Description", justify="center")
+        table.add_column("Solution Components", justify="center")
 
         blueprints = client.find_solution_blueprints(search_string)
         if isinstance(blueprints, list) is False:
@@ -89,10 +91,15 @@ def blueprint_list(
             bp_guid = bp["elementHeader"]["guid"]
             bp_desc = bp["properties"].get("description",'---')
             bp_unique_name = f"{bp_qname}\n\n\t\t/\n\n{bp_guid}"
-            bp_mermaid = bp.get("mermaid",'---')
+            bp_mermaid = bp.get("mermaidGraph",'---')
+            if bp_mermaid != '---':
+                link = save_mermaid_html(bp_name, bp_mermaid, EGERIA_MERMAID_FOLDER)
+                bp_mermaid = f"![{bp_name}]({link})"
+            bp_mermaid_label = f"{bp_name}\n\n\t\t/\n\n{bp_mermaid}"
 
             bp_components = bp.get("solutionComponents",[])
             comp_md=""
+            first_comp = True
             for component in bp_components:
                 comp = component.get("solutionComponent","")
                 if isinstance(comp,dict) is False:
@@ -102,6 +109,7 @@ def blueprint_list(
                 comp_description = comp_props.get("description",'---')
                 comp_planned = comp_props['extendedProperties'].get("plannedDeployedImplementationType",'---')
                 comp_type = comp_props.get('solutionComponentType','---')
+
                 comp_actors = comp_props.get('actors', [])
                 comp_actors_list = ""
                 for actor in comp_actors:
@@ -111,13 +119,16 @@ def blueprint_list(
                     for prop in comp_actor_props.keys():
                         comp_actor_props_md += f"* {prop}: {comp_actor_props[prop]}\n"
                     comp_actors_list += comp_actor_props_md
-
+                if first_comp:
+                    first_comp = False
+                else:
+                    comp_md += "\n\n---\n\n"
                 comp_md = f"Solution Component {comp_name}\n\n"
                 comp_md += f"* Description: {comp_description}\n"
                 comp_md += f"* Planned Deployment: {comp_planned}\n"
-                comp_md += f"* Actors: {comp_actors_list}\n---\n"
+                comp_md += f"* Actors: {comp_actors_list}\n"
             comp_out = Markdown(comp_md)
-            table.add_row(bp_name, bp_unique_name, bp_desc, comp_out)
+            table.add_row(bp_mermaid_label, bp_unique_name, bp_desc, comp_out)
 
         return table
 

pyegeria-5.3.3.14/pyegeria/commands/tech/work/mermaid_graphs/Automated Manufacturing Control.html

@@ -0,0 +1,121 @@
+
+    <!DOCTYPE html>
+    <html>
+        <head>
+          <style type="text/css">
+            #mySvgId {
+            width: 100%;
+            height: 600px;
+            overflow: scroll;
+            border: 2px solid #ccc;
+            position: relative;
+            margin-bottom: 10px;
+            }
+            svg {
+            cursor: grab;
+            }
+    
+          </style>
+        </head>
+    
+        <title>Component for Solution Blueprint - Automated Manufacturing Control </title>
+        <h3 style="text-align: center;">Component for Solution Blueprint - Automated Manufacturing Control </h3>
+        GUID : 8a222c5d-b206-454f-b861-2b803cfe3cbd
+
+    
+        <body>
+        
+          <div id="graphDiv"></div>
+          <script src="https://bumbu.me/svg-pan-zoom/dist/svg-pan-zoom.min.js"></script>
+          <script type="module">
+            import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
+    
+            mermaid.initialize({startOnLoad: false});
+            await mermaid.run({
+              querySelector: '.mermaid',
+              postRenderCallback: (id) => {
+                const container = document.getElementById("diagram-container");
+                const svgElement = container.querySelector("svg");
+    
+                // Initialize Panzoom
+                const panzoomInstance = Panzoom(svgElement, {
+                  maxScale: 5,
+                  minScale: 0.5,
+                  step: 0.1,
+                });
+    
+                // Add mouse wheel zoom
+                container.addEventListener("wheel", (event) => {
+                  panzoomInstance.zoomWithWheel(event);
+                });
+              }
+            });
+    
+    
+            const drawDiagram = async function () {
+              const element = document.querySelector('#graphDiv');
+              const graphDefinition = `
+    flowchart TD
+%%{init: {"flowchart": {"htmlLabels": false}} }%%
+
+subgraph 8a222c5d-b206-454f-b861-2b803cfe3cbd [Components and Actors]
+c3967953-fb5a-45a4-8d89-bcc62962e1da@{ shape: text, label: "*Description*
+**A description of how the new industry 4.0 manufacturing control system operates.**"}
+end
+style c3967953-fb5a-45a4-8d89-bcc62962e1da color:#000000, fill:#F9F7ED, stroke:#b7c0c7
+style 8a222c5d-b206-454f-b861-2b803cfe3cbd color:#3079ab, fill:#b7c0c7, stroke:#3079ab`;
+              const {svg} = await mermaid.render('mySvgId', graphDefinition);
+              element.innerHTML = svg.replace(/( )*max-width:( 0-9\.)*px;/i, '');
+    
+              var doPan = false;
+              var eventsHandler;
+              var panZoom;
+              var mousepos;
+    
+              eventsHandler = {
+                haltEventListeners: ['mousedown', 'mousemove', 'mouseup']
+    
+                , mouseDownHandler: function (ev) {
+                  if (event.target.className == "[object SVGAnimatedString]") {
+                    doPan = true;
+                    mousepos = {x: ev.clientX, y: ev.clientY}
+                  }
+                  ;
+                }
+    
+                , mouseMoveHandler: function (ev) {
+                  if (doPan) {
+                    panZoom.panBy({x: ev.clientX - mousepos.x, y: ev.clientY - mousepos.y});
+                    mousepos = {x: ev.clientX, y: ev.clientY};
+                    window.getSelection().removeAllRanges();
+                  }
+                }
+    
+                , mouseUpHandler: function (ev) {
+                  doPan = false;
+                }
+    
+                , init: function (options) {
+                  options.svgElement.addEventListener('mousedown', this.mouseDownHandler, false);
+                  options.svgElement.addEventListener('mousemove', this.mouseMoveHandler, false);
+                  options.svgElement.addEventListener('mouseup', this.mouseUpHandler, false);
+                }
+    
+                , destroy: function (options) {
+                  options.svgElement.removeEventListener('mousedown', this.mouseDownHandler, false);
+                  options.svgElement.removeEventListener('mousemove', this.mouseMoveHandler, false);
+                  options.svgElement.removeEventListener('mouseup', this.mouseUpHandler, false);
+                }
+              }
+              panZoom = svgPanZoom('#mySvgId', {
+                zoomEnabled: true
+                , controlIconsEnabled: true
+                , fit: 1
+                , center: 1
+                , customEventsHandler: eventsHandler
+              })
+            };
+            await drawDiagram();
+          </script>
+        </body>    
+