pyegeria 5.4.5__tar.gz → 5.4.7__tar.gz

pyegeria-5.4.7/MANIFEST.in

@@ -0,0 +1 @@
+    recursive-include examples *

{pyegeria-5.4.5 → pyegeria-5.4.7}/PKG-INFO

@@ -1,40 +1,37 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyegeria
-Version: 5.4.5
+Version: 5.4.7
 Summary: A python client for Egeria
-License: Apache 2.0
+Author-email: Dan Wolfson <dan.wolfson@pdr-associates.com>
+License-Expression: Apache-2.0
 Keywords: egeria,metadata,governance
-Author: Dan Wolfson
-Author-email: dan.wolfson@pdr-associates.com
-Requires-Python: >3.12,<4.0.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: click
+Requires-Python: >3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: httpx
-Requires-Dist: inflect (>=7.5.0,<8.0.0)
-Requires-Dist: jupyter
-Requires-Dist: jupyter-notebook-parser (>=0.1.4,<0.2.0)
-Requires-Dist: loguru (>=0.7.3,<0.8.0)
-Requires-Dist: mermaid-py
-Requires-Dist: poetry-core (>=2.1.3,<3.0.0)
-Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
-Requires-Dist: pydantic (>=2.11.7,<3.0.0)
-Requires-Dist: pydantic-settings (>=2.10.1,<3.0.0)
-Requires-Dist: pydevd-pycharm (>=252.23892.364,<253.0.0)
-Requires-Dist: pytest (>=8.3.5,<9.0.0)
-Requires-Dist: requests
 Requires-Dist: rich
-Requires-Dist: textual
-Requires-Dist: trogon (>=0.6.0,<0.7.0)
-Requires-Dist: urllib3
 Requires-Dist: validators
-Requires-Dist: wcwidth (==0.2.13)
-Project-URL: Homepage, https://github.com/odpi/egeria-python
-Project-URL: Repository, https://github.com/odpi/egeria-python
-Description-Content-Type: text/markdown
+Requires-Dist: urllib3
+Requires-Dist: requests
+Requires-Dist: jupyter
+Requires-Dist: click
+Requires-Dist: trogon
+Requires-Dist: textual
+Requires-Dist: mermaid-py
+Requires-Dist: psycopg2-binary
+Requires-Dist: jupyter-notebook-parser
+Requires-Dist: loguru
+Requires-Dist: inflect
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: pydevd-pycharm>=252.23892.364
+Requires-Dist: wcwidth
+Requires-Dist: altair
+Requires-Dist: modelcontextprotocol
+Requires-Dist: mcp>=1.15.0
+Dynamic: license-file
 
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project. -->

pyegeria-5.4.7/examples/Coco_config/README.md

@@ -0,0 +1,19 @@
+# pyegeria: Coco Pharmaceuticals Lab Configurations
+
+This is an experimental package that demonstrates how we can configure the servers used in the 
+Egeria Jupyter Labs [Egeria Project - Open metadata and governance for enterprises](https://egeria-project.org/guides/operations/kubernetes/charts/lab/?h=coco) 
+using the new pyegeria client.
+
+This package will evolve with planned enhancements to the Coco Pharmaceuticals Jupyter Labs.
+
+All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/), 
+team calls, or via github issues in this repo. If interested in contributing,
+you can engage via the community or directly reach out to
+[dan.wolfson\@pdr-associates.com](mailto:dan.wolfson@pdr-associates.com?subject=pyegeria).
+
+This is a learning experience.
+
+
+----
+License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
+Copyright Contributors to the ODPi Egeria project.

pyegeria-5.4.7/examples/Coco_config/__init__.py

@@ -0,0 +1,4 @@
+"""
+
+Coco Pharmaceuticals Configurations
+"""

pyegeria-5.4.7/examples/Coco_config/config_cocoMDS1.py

@@ -0,0 +1,108 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Egeria Coco Pharmaceutical demonstration labs.
+
+Configuring cocoMDS1 - Data Lake Operations metadata server
+
+"""
+
+import json
+
+from globals import adminUserId, cocoCohort, cocoMDS1Name, dataLakePlatformURL
+
+from pyegeria import CoreServerConfig, Platform, print_exception_response
+
+mdr_server = cocoMDS1Name
+platform_url = dataLakePlatformURL
+admin_user = adminUserId
+mdr_server_user_id = "cocoMDS1npa"
+mdr_server_password = "cocoMDS1passw0rd"
+metadataCollectionId = f"{mdr_server}-e915f2fa-aa3g-4396-8bde-bcd65e642b1d"
+metadataCollectionName = "Data Lake Catalog"
+
+max_page_size = 600
+
+print("Configuring " + mdr_server + "..." + " @ " + platform_url)
+
+try:
+    o_client = CoreServerConfig(mdr_server, platform_url, admin_user)
+
+    o_client.set_basic_server_properties(
+        "Data lake operations",
+        "Coco Pharmaceuticals",
+        platform_url,
+        mdr_server_user_id,
+        mdr_server_password,
+        max_page_size,
+        mdr_server,
+    )
+
+    # Can also inherit event bus config from application properties
+
+    event_bus_config = {
+        "producer": {"bootstrap.servers": "{{kafkaEndpoint}}"},
+        "consumer": {"bootstrap.servers": "{{kafkaEndpoint}}"},
+    }
+
+    o_client.set_event_bus(event_bus_config)
+
+    security_connection_body = {
+        "class": "Connection",
+        "connectorType": {
+            "class": "ConnectorType",
+            "connectorProviderClassName": "org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider",
+        },
+    }
+    o_client.set_xtdb_local_kv_repository()
+    # o_client.set_in_mem_local_repository()
+    o_client.add_default_log_destinations()
+    o_client.set_server_security_connection(security_connection_body)
+    o_client.set_local_metadata_collection_name(metadataCollectionName)
+    o_client.set_local_metadata_collection_id(metadataCollectionId)
+
+    o_client.add_cohort_registration(cocoCohort)
+
+    print(f"Configuring {mdr_server}  Access Services (OMAS)....")
+
+    # o_client.configure_all_access_services()
+    access_service_options = {
+        "SupportedZones": [
+            "quarantine",
+            "clinical-trials",
+            "research",
+            "data-lake",
+            "trash-can",
+        ]
+    }
+
+    # o_client.configure_access_service("asset-catalog", access_service_options)
+    o_client.configure_access_service("asset-consumer", access_service_options)
+
+    access_service_options["DefaultZones"] = ["quarantine"]
+    access_service_options["PublishZones"] = ["data-lake"]
+
+    # print(f"Access Service Options: {access_service_options}")
+
+    o_client.configure_access_service("asset-manager", access_service_options)
+    o_client.configure_access_service("asset-owner", access_service_options)
+    o_client.configure_access_service("community-profile", {"KarmaPointPlateau": "500"})
+    # o_client.configure_access_service("glossary-view", {})
+    # o_client.configure_access_service("data-engine", access_service_options)
+    o_client.configure_access_service("data-manager", access_service_options)
+    o_client.configure_access_service("digital-architecture", access_service_options)
+    o_client.configure_access_service("governance-engine", access_service_options)
+    o_client.configure_access_service("governance-server", access_service_options)
+    o_client.configure_access_service("asset-lineage", access_service_options)
+
+    print(f"Activating {mdr_server}")
+    p_client = Platform(mdr_server, platform_url, admin_user)
+    p_client.activate_server_stored_config()
+
+    config = o_client.get_stored_configuration()
+    print(f"\n\n\tConfiguration of {mdr_server} is complete.")
+    print(f"\nThe server stored configuration is:\n {json.dumps(config, indent=4)}")
+
+except Exception as e:
+    print_exception_response(e)

pyegeria-5.4.7/examples/Coco_config/config_cocoMDS2.py

@@ -0,0 +1,126 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Egeria Coco Pharmaceutical demonstration labs.
+
+This script creates and configures the cocoMDS2 - Governance metadata server
+
+
+"""
+
+import json
+
+from globals import (
+    cocoCohort,
+    cocoMDS2Name,
+    corePlatformURL,
+    devCohort,
+    iotCohort,
+    max_paging_size,
+)
+
+from pyegeria import CoreServerConfig, Platform, print_exception_response
+
+disable_ssl_warnings = True
+
+mdr_server = cocoMDS2Name
+platform_url = corePlatformURL
+admin_user = "garygeeke"
+mdr_server_user_id = "cocoMDS2npa"
+mdr_server_password = "cocoMDS2passw0rd"
+metadataCollectionId = f"{mdr_server}-e915f2fa-aa3g-4396-8bde-bcd65e642b1d"
+metadataCollectionName = "Governance Catalog"
+
+print("Configuring " + mdr_server + "...")
+
+try:
+    o_client = CoreServerConfig(mdr_server, platform_url, admin_user)
+
+    o_client.set_basic_server_properties(
+        "Governance Server",
+        "Coco Pharmaceuticals",
+        platform_url,
+        mdr_server_user_id,
+        mdr_server_password,
+        max_paging_size,
+    )
+
+    #   Inherit event bus config
+
+    event_bus_config = {
+        "producer": {"bootstrap.servers": "{{kafkaEndpoint}}"},
+        "consumer": {"bootstrap.servers": "{{kafkaEndpoint}}"},
+    }
+
+    o_client.set_event_bus(event_bus_config)
+
+    security_connection_body = {
+        "class": "Connection",
+        "connectorType": {
+            "class": "ConnectorType",
+            "connectorProviderClassName": "org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider",
+        },
+    }
+
+    o_client.set_server_security_connection(security_connection_body)
+    o_client.add_default_log_destinations()
+
+    # o_client.set_in_mem_local_repository()
+    # o_client.set_xtdb_local_kv_repository()
+    body = {
+        "xtdbConfigEDN": """{:xtdb/index-store {:kv-store {:xtdb/module xtdb.rocksdb/->kv-store :db-dir "data/servers/xtdb/rdb-index"}}
+                                                :xtdb.lucene/lucene-store {:db-dir "data/servers/xtdb/lucene"
+                                                                             :indexer {:xtdb/module xtdb.lucene.egeria/->egeria-indexer}
+                                                                             :analyzer {:xtdb/module xtdb.lucene.egeria/->ci-analyzer}}
+                                                  :xtdb.jdbc/connection-pool {:dialect {:xtdb/module xtdb.jdbc.psql/->dialect}
+                                                                              :db-spec {:jdbcUrl "jdbc:postgresql://host.docker.internal:5442/xtdb?user=postgres&password=egeria"}}
+                                                  :xtdb/tx-log {:xtdb/module xtdb.jdbc/->tx-log
+                                                                :connection-pool :xtdb.jdbc/connection-pool
+                                                                :poll-sleep-duration "PT1S"}
+                                                  :xtdb/document-store {:xtdb/module xtdb.jdbc/->document-store
+                                                                        :connection-pool :xtdb.jdbc/connection-pool}}""",
+        "syncIndex": True,
+    }
+    o_client.add_startup_open_metadata_archive_file(
+        "content-packs/CoreContentPack.omarchive"
+    )
+    o_client.set_xtdb_local_repository(body)
+    o_client.set_local_metadata_collection_id(metadataCollectionId)
+    o_client.set_local_metadata_collection_name(metadataCollectionName)
+
+    o_client.add_cohort_registration(cocoCohort)
+    o_client.add_cohort_registration(devCohort)
+    o_client.add_cohort_registration(iotCohort)
+
+    print(f"Configuring {mdr_server}  Access Services (OMAS)....")
+
+    # o_client.configure_access_service("asset-catalog", {})
+    o_client.configure_access_service("asset-consumer", {})
+
+    o_client.configure_access_service("asset-owner", {})
+    o_client.configure_access_service("community-profile", {"KarmaPointPlateau": "500"})
+    # o_client.configure_access_service("glossary-view", {})
+    # o_client.configure_access_service("subject-area", {})
+    o_client.configure_access_service("governance-engine", {})
+    o_client.configure_access_service("governance-server", {})
+    o_client.configure_access_service("governance-program", {})
+    # o_client.configure_access_service("data-privacy", {})
+    o_client.configure_access_service("digital-architecture", {})
+    # o_client.configure_access_service("security-manager", {})
+    # o_client.configure_access_service("asset-lineage", {})
+    # o_client.configure_access_service("it-infrastructure", {})
+    # o_client.configure_access_service("project-management", {})
+
+    p_client = Platform(mdr_server, platform_url, admin_user)
+    p_client.activate_server_stored_config()
+
+    print(f"\n\n\tConfiguration of {mdr_server} is complete.")
+
+    config = o_client.get_stored_configuration()
+    print(f"The server stored configuration is \n{json.dumps(config, indent=4)}")
+
+except Exception as e:
+    print_exception_response(e)

pyegeria-5.4.7/examples/Coco_config/config_cocoMDS3.py

@@ -0,0 +1,109 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Egeria Coco Pharmaceutical demonstration labs.
+
+This script creates and configures the cocoMDS3 - Research server.
+
+"""
+
+import json
+
+from globals import cocoCohort, cocoMDS3Name, corePlatformURL, max_paging_size
+
+from pyegeria import print_exception_response
+from pyegeria.core_omag_server_config import CoreServerConfig
+from pyegeria.platform_services import Platform
+
+mdr_server = cocoMDS3Name
+platform_url = corePlatformURL
+admin_user = "garygeeke"
+mdr_server_user_id = "cocoMDS3npa"
+mdr_server_password = "cocoMDS3passw0rd"
+metadataCollectionId = f"{mdr_server}-e915f2fa-aa3g-4396-8bde-bcd65e642b1d"
+metadataCollectionName = "Research Catalog"
+
+print("Configuring " + mdr_server + "...")
+try:
+    o_client = CoreServerConfig(mdr_server, platform_url, admin_user)
+
+    o_client.set_basic_server_properties(
+        "Research Server",
+        "Coco Pharmaceuticals",
+        platform_url,
+        mdr_server_user_id,
+        mdr_server_password,
+        max_paging_size,
+    )
+
+    # Can inherit event bus config
+
+    # event_bus_config = {
+    #     "producer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     },
+    #     "consumer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     }
+    # }
+    #
+    # o_client.set_event_bus(event_bus_config)
+
+    security_connection_body = {
+        "class": "Connection",
+        "connectorType": {
+            "class": "ConnectorType",
+            "connectorProviderClassName": "org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider",
+        },
+    }
+    o_client.set_server_security_connection(security_connection_body)
+    o_client.add_default_log_destinations()
+
+    # o_client.set_in_mem_local_repository()
+    o_client.set_xtdb_local_kv_repository()
+
+    o_client.set_local_metadata_collection_id(metadataCollectionId)
+    o_client.set_local_metadata_collection_name(metadataCollectionName)
+
+    o_client.add_cohort_registration(cocoCohort)
+
+    print(f"Configuring {mdr_server}  Access Services (OMAS)....")
+
+    access_service_options = {
+        "SupportedZones": [
+            "personal-files",
+            "clinical-trials",
+            "research",
+            "data-lake",
+            "trash-can",
+        ]
+    }
+    # o_client.configure_access_service("asset-catalog", access_service_options)
+    o_client.configure_access_service("asset-consumer", access_service_options)
+
+    access_service_options["DefaultZones"] = ["personal-files"]
+
+    o_client.configure_access_service("asset-owner", access_service_options)
+    o_client.configure_access_service("community-profile", {"KarmaPointPlateau": "500"})
+    # o_client.configure_access_service("glossary-view", {})
+    o_client.configure_access_service("data-science", {})
+    # o_client.configure_access_service("subject-area", {})
+    o_client.configure_access_service("asset-manager", access_service_options)
+    o_client.configure_access_service("governance-engine", access_service_options)
+    o_client.configure_access_service("governance-server", access_service_options)
+
+    o_client.configure_access_service("project-management", access_service_options)
+
+    p_client = Platform(mdr_server, platform_url, admin_user)
+    p_client.activate_server_stored_config()
+
+    print(f"\n\n\tConfiguration of {mdr_server} is complete.")
+
+    config = o_client.get_stored_configuration()
+    print(f"The server stored configuration is \n{json.dumps(config, indent=4)}")
+
+except Exception as e:
+    print_exception_response(e)

pyegeria-5.4.7/examples/Coco_config/config_cocoMDS4.py

@@ -0,0 +1,91 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Egeria Coco Pharmaceutical demonstration labs.
+
+This script creates and configures the cocoMDS4 - Data Lake Users
+
+"""
+
+import json
+
+from globals import cocoCohort, cocoMDS4Name, dataLakePlatformURL, max_paging_size
+
+from pyegeria import CoreServerConfig, Platform, print_exception_response
+
+disable_ssl_warnings = True
+
+mdr_server = cocoMDS4Name
+platform_url = dataLakePlatformURL
+admin_user = "garygeeke"
+mdr_server_user_id = "cocoMDS4npa"
+mdr_server_password = "cocoMDS4passw0rd"
+metadataCollectionId = f"{mdr_server}-e915f2fa-aa3g-4396-8bde-bcd65e642b1d"
+metadataCollectionName = "Data Lake Users"
+
+print("Configuring " + mdr_server + "...")
+
+try:
+    o_client = CoreServerConfig(mdr_server, platform_url, admin_user)
+
+    o_client.set_basic_server_properties(
+        "Data Lake Users",
+        "Coco Pharmaceuticals",
+        platform_url,
+        mdr_server_user_id,
+        mdr_server_password,
+        max_paging_size,
+    )
+
+    # Inherit event bus config
+
+    # event_bus_config = {
+    #     "producer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     },
+    #     "consumer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     }
+    # }
+    #
+    # o_client.set_event_bus(event_bus_config)
+
+    security_connection_body = {
+        "class": "Connection",
+        "connectorType": {
+            "class": "ConnectorType",
+            "connectorProviderClassName": "org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider",
+        },
+    }
+
+    o_client.set_server_security_connection(security_connection_body)
+    o_client.add_default_log_destinations()
+
+    # Note: no metadata repository or collection configuration in this server.
+
+    o_client.add_cohort_registration(cocoCohort)
+
+    print(f"Configuring {mdr_server}  Access Services (OMAS)....")
+
+    accessServiceOptions = {"SupportedZones": ["data-lake"]}
+
+    # o_client.configure_access_service("asset-catalog", accessServiceOptions)
+    o_client.configure_access_service("asset-consumer", accessServiceOptions)
+    o_client.configure_access_service("asset-owner", {})
+    o_client.configure_access_service("community-profile", {"KarmaPointPlateau": "500"})
+    # o_client.configure_access_service("glossary-view", {})
+    o_client.configure_access_service("data-science", accessServiceOptions)
+
+    p_client = Platform(mdr_server, platform_url, admin_user)
+    p_client.activate_server_stored_config()
+
+    print(f"\n\n\tConfiguration of {mdr_server} is complete.")
+
+    config = o_client.get_stored_configuration()
+    print(f"The server stored configuration is \n{json.dumps(config, indent=4)}")
+
+except Exception as e:
+    print_exception_response(e)

pyegeria-5.4.7/examples/Coco_config/config_cocoMDS5.py

@@ -0,0 +1,116 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Egeria Coco Pharmaceutical demonstration labs.
+
+This script creates and configures the cocoMDS5 - Business Systems
+
+"""
+
+import json
+
+from globals import (
+    adminUserId,
+    cocoCohort,
+    cocoMDS1Name,
+    cocoMDS2Name,
+    cocoMDS3Name,
+    cocoMDS4Name,
+    cocoMDS5Name,
+    cocoMDS6Name,
+    cocoMDSxName,
+    cocoOLS1Name,
+    cocoView1Name,
+    corePlatformName,
+    corePlatformURL,
+    dataLakePlatformName,
+    dataLakePlatformURL,
+    devCohort,
+    devPlatformName,
+    devPlatformURL,
+    iotCohort,
+    max_paging_size,
+)
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria.core_omag_server_config import CoreServerConfig
+from pyegeria.platform_services import Platform
+
+disable_ssl_warnings = True
+
+mdr_server = cocoMDS5Name
+platform_url = corePlatformURL
+admin_user = "garygeeke"
+mdr_server_user_id = "cocoMDS5npa"
+mdr_server_password = "cocoMDS5passw0rd"
+metadataCollectionId = f"{mdr_server}-e915f2fa-aa3g-4396-8bde-bcd65e642b1d"
+metadataCollectionName = "Business Systems Catalog"
+
+print("Configuring " + mdr_server + "...")
+try:
+    o_client = CoreServerConfig(mdr_server, platform_url, admin_user)
+
+    o_client.set_basic_server_properties(
+        "Business Systems",
+        "Coco Pharmaceuticals",
+        platform_url,
+        mdr_server_user_id,
+        mdr_server_password,
+        max_paging_size,
+    )
+
+    # Inherit event bus config
+
+    # event_bus_config = {
+    #     "producer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     },
+    #     "consumer": {
+    #         "bootstrap.servers": "localhost:9092"
+    #     }
+    # }
+    #
+    # o_client.set_event_bus(event_bus_config)
+
+    security_connection_body = {
+        "class": "Connection",
+        "connectorType": {
+            "class": "ConnectorType",
+            "connectorProviderClassName": "org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaServerSecurityProvider",
+        },
+    }
+    o_client.set_server_security_connection(security_connection_body)
+    o_client.add_default_log_destinations()
+
+    # o_client.set_in_mem_local_repository()
+    o_client.set_xtdb_local_kv_repository()
+
+    o_client.set_local_metadata_collection_id(metadataCollectionId)
+    o_client.set_local_metadata_collection_name(metadataCollectionName)
+
+    o_client.add_cohort_registration(cocoCohort)
+
+    proxy_details = (
+        "org.odpi.openmetadata.adapters.repositoryservices.readonly.repositoryconnector."
+        + "ReadOnlyOMRSRepositoryConnectorProvider"
+    )
+    o_client.set_repository_proxy_details(proxy_details)
+
+    p_client = Platform(mdr_server, platform_url, admin_user)
+    p_client.activate_server_stored_config()
+
+    print(f"\n\n\tConfiguration of {mdr_server} is complete.")
+
+    config = o_client.get_stored_configuration()
+    print(f"The server stored configuration is \n{json.dumps(config, indent=4)}")
+
+except Exception as e:
+    print_exception_response(e)