pyegeria 5.4.8.6__py3-none-any.whl → 5.4.8.8__py3-none-any.whl

examples/Jupyter Notebooks/common/environment-check.ipynb

@@ -0,0 +1,53 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "\n",
+    "#\n",
+    "# Perform basic checks to ensure the calling notebook has a good environment to work against.\n",
+    "# These are the only calls to run functions defined above.\n",
+    "#\n",
+    "from pyegeria import Platform, CoreServerConfig, utils\n",
+    "print(\"\\nChecking OMAG Server Platform availability...\")\n",
+    "\n",
+    "activatePlatform(corePlatformName, corePlatformURL, [cocoMDS2Name, cocoMDS3Name, cocoMDS5Name, cocoMDS6Name])\n",
+    "activatePlatform(dataLakePlatformName, dataLakePlatformURL, [cocoMDS1Name, cocoMDS4Name, cocoView1Name, cocoOLS1Name])\n",
+    "activatePlatform(devPlatformName, devPlatformURL, [cocoMDSxName])\n",
+    "\n",
+    "print (\"Done.\")\n",
+    "print (\" \")\n",
+    "\n",
+    "\n",
+    "def checkServerConfigured(server_name:str, server_platform_name:str, server_platform_url: str) -> bool\n",
+    "    "
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/Jupyter Notebooks/common/globals.ipynb

@@ -0,0 +1,184 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#\n",
+    "# This file contains the common functions and definitions used in all Egeria Hands on\n",
+    "# Lab Notebooks. Typically these will be system-wide functions and common environment settings\n",
+    "#\n",
+    "\n",
+    "\n",
+    "#\n",
+    "# Disable certificate checking for local development use with self-signed certificate \n",
+    "#\n",
+    "\n",
+    "import urllib3\n",
+    "urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)\n",
+    "\n",
+    "import os\n",
+    "os.environ['CURL_CA_BUNDLE'] = ''\n",
+    "\n",
+    "#\n",
+    "# This is the location of the file system that is used in the lab.  It defaults to a \"data\" subfolder in\n",
+    "# the platform's home folder.  Here you will finc the runtime files of the platforms and the data files\n",
+    "# used in various labs.  The default value can be overridden using the \"fileSystemRoot\" environment variable.\n",
+    "#\n",
+    "fileSystemRoot = os.environ.get('fileSystemRoot', 'data')\n",
+    "#\n",
+    "# This is directory where the sample data from the Egeria distribution has been unpacked in.  The default value\n",
+    "# describes its location in an IntelliJ workspace.  The default value can be overridden using the \"egeriaDistributionRoot\" \n",
+    "# environment variable.\n",
+    "#\n",
+    "egeriaSampleDataRoot = os.environ.get('egeriaSampleDataRoot', '.')\n",
+    "#\n",
+    "# Flag to enable debug, this cases extra information to be printed including rest calls request and response details\n",
+    "# Switching this flag to True produces a very large amount of output and is not recommended.\n",
+    "# A targeted use of this flag is recommended, set this before and reset this after the code you would like to produce debug\n",
+    "#\n",
+    "isDebug = False\n",
+    "#\n",
+    "# Definitions of the Coco Pharmaceuticals Environment\n",
+    "#\n",
+    "\n",
+    "# These are the three main platforms used to run Egeria's OMAG Servers\n",
+    "corePlatformURL      = os.environ.get('corePlatformURL', 'https://localhost:9443')\n",
+    "corePlatformName     = \"Core Platform\"\n",
+    "\n",
+    "dataLakePlatformURL  = os.environ.get('dataLakePlatformURL', 'https://localhost:9444')\n",
+    "dataLakePlatformName = \"Data Lake Platform\"\n",
+    "\n",
+    "devPlatformURL       = os.environ.get('devPlatformURL', 'https://localhost:9445')\n",
+    "devPlatformName      = \"Dev Platform\"\n",
+    "\n",
+    "\n",
+    "# The OMAG Server Platforms host one to many OMAG Servers.  An OMAG Server could be\n",
+    "# a metadata server or a specialized governance server.  Its behavior is determined\n",
+    "# by a configuration document that defines which OMAG services are activated.\n",
+    "# All OMAG Server Platforms support the administration md_commands to define a server's\n",
+    "# configuration document.  It is also possible to create configuration documents\n",
+    "# through admin calls to one OMAG Server Platform and then deploy them to the\n",
+    "# OMAG Server Platform where they are to run.  In the Egeria hands on lab, the\n",
+    "# OMAG Server configuration is created on the dev platform and deployed to the\n",
+    "# production platforms as needed.\n",
+    "\n",
+    "adminPlatformURL = devPlatformURL\n",
+    "\n",
+    "# Gary Geeke is the IT Administration Lead at Coco Pharmaceuticals.\n",
+    "# He does all of the configuration for the OMAG Servers. Other users are introduced and make\n",
+    "# calls to the server as required\n",
+    "\n",
+    "adminUserId   = \"garygeeke\"\n",
+    "petersUserId  = \"peterprofile\"\n",
+    "erinsUserId   = \"erinoverview\"\n",
+    "calliesUserId = \"calliequartile\"\n",
+    "faithsUserId  = \"faithbroker\"\n",
+    "harrysUserId  = \"harryhopeful\"\n",
+    "\n",
+    "# These are the names of the metadata servers used by Coco Pharmaceuticals.  Each metadata\n",
+    "# server runs as an OMAG Server on one of the OMAG Server Platforms\n",
+    "\n",
+    "cocoMDS1PlatformURL  = dataLakePlatformURL\n",
+    "cocoMDS1PlatformName = dataLakePlatformName\n",
+    "cocoMDS1Name         = \"cocoMDS1\"\n",
+    "\n",
+    "cocoMDS2PlatformURL  = corePlatformURL\n",
+    "cocoMDS2PlatformName = corePlatformName\n",
+    "cocoMDS2Name         = \"cocoMDS2\"\n",
+    "\n",
+    "cocoMDS3PlatformURL  = corePlatformURL\n",
+    "cocoMDS3PlatformName = corePlatformName\n",
+    "cocoMDS3Name         = \"cocoMDS3\"\n",
+    "\n",
+    "cocoMDS4PlatformURL  = dataLakePlatformURL\n",
+    "cocoMDS4PlatformName = dataLakePlatformName\n",
+    "cocoMDS4Name         = \"cocoMDS4\"\n",
+    "\n",
+    "cocoMDS5PlatformURL  = corePlatformURL\n",
+    "cocoMDS5PlatformName = corePlatformName\n",
+    "cocoMDS5Name         = \"cocoMDS5\"\n",
+    "\n",
+    "cocoMDS6PlatformURL  = corePlatformURL\n",
+    "cocoMDS6PlatformName = corePlatformName\n",
+    "cocoMDS6Name         = \"cocoMDS6\"\n",
+    "\n",
+    "cocoMDSxPlatformURL  = devPlatformURL\n",
+    "cocoMDSxPlatformName = devPlatformName\n",
+    "cocoMDSxName         = \"cocoMDSx\"\n",
+    "\n",
+    "cocoOLS1PlatformName = dataLakePlatformName\n",
+    "cocoOLS1PlafformURL  = dataLakePlatformURL\n",
+    "cocoOLS1Name         = \"cocoOLS1\"\n",
+    "\n",
+    "# The open metadata servers are linked together through the following open metadata cohorts.\n",
+    "# The servers linked via a cohort can exchange open metadata either through federated\n",
+    "# queries or metadata replication.\n",
+    "\n",
+    "cocoCohort = \"cocoCohort\"\n",
+    "devCohort  = \"devCohort\"\n",
+    "iotCohort  = \"iotCohort\"\n",
+    "ctsCohort  = \"ctsCohort\"\n",
+    "\n",
+    "# This is the view server that runs the services that support Egeria's user interface.\n",
+    "\n",
+    "cocoView1PlatformURL  = dataLakePlatformURL\n",
+    "cocoView1PlatformName = dataLakePlatformName\n",
+    "cocoView1Name = \"cocoView1\"\n",
+    "\n",
+    "# These are the names of the governance servers used in Coco Pharmaceuticals' data lake.\n",
+    "# Each governance server runs as an OMAG Server on the Data Lake OMAG Server Platform.\n",
+    "# They also connect to a metadata server to retrieve their configuration and store their\n",
+    "# results.\n",
+    "\n",
+    "governDL01PlatformURL    = dataLakePlatformURL\n",
+    "governDL01PlatformName   = dataLakePlatformName\n",
+    "governDL01Name           = \"governDL01\"\n",
+    "governDL01ServerType     = \"Engine Host\"\n",
+    "governDL01MDS            = \"cocoMDS1\"\n",
+    "\n",
+    "exchangeDL01PlatformURL  = dataLakePlatformURL\n",
+    "exchangeDL01PlatformName = dataLakePlatformName\n",
+    "exchangeDL01Name         = \"exchangeDL01\"\n",
+    "exchangeDL01ServerType   = \"Integration Daemon\"\n",
+    "exchangeDL01MDS          = \"cocoMDS1\"\n",
+    "\n",
+    "monitorGov01PlatformURL  = dataLakePlatformURL\n",
+    "monitorGov01PlatformName = dataLakePlatformName\n",
+    "monitorGov01Name         = \"monitorGov01\"\n",
+    "monitorGov01ServerType   = \"Integration Daemon\"\n",
+    "monitorGov01MDS          = \"cocoMDS1\"\n",
+    "\n",
+    "monitorDev01PlatformURL  = devPlatformURL\n",
+    "monitorDev01PlatformName = devPlatformName\n",
+    "monitorDev01Name         = \"monitorDev01\"\n",
+    "monitorDev01ServerType   = \"Integration Daemon\"\n",
+    "monitorDev01MDS          = \"cocoMDSx\"\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/Jupyter Notebooks/common/globals.py

@@ -0,0 +1,154 @@
+#
+# This file contains the common functions and definitions used in all Egeria Hands on
+# Lab Notebooks. Typically these will be system-wide functions and common environment settings
+#
+
+
+#
+# Disable certificate checking for local development use with self-signed certificate
+#
+
+import urllib3
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+import os
+
+os.environ["CURL_CA_BUNDLE"] = ""
+
+#
+# This is the location of the file system that is used in the lab.  It defaults to a "data" subfolder in
+# the platform's home folder.  Here you will finc the runtime files of the platforms and the data files
+# used in various labs.  The default value can be overridden using the "fileSystemRoot" environment variable.
+#
+fileSystemRoot = os.environ.get("fileSystemRoot", "data")
+#
+# This is directory where the sample data from the Egeria distribution has been unpacked in.  The default value
+# describes its location in an IntelliJ workspace.  The default value can be overridden using the "egeriaDistributionRoot"
+# environment variable.
+#
+egeriaSampleDataRoot = os.environ.get("egeriaSampleDataRoot", ".")
+#
+# Flag to enable debug, this cases extra information to be printed including rest calls request and response details
+# Switching this flag to True produces a very large amount of output and is not recommended.
+# A targeted use of this flag is recommended, set this before and reset this after the code you would like to produce debug
+#
+isDebug = False
+disable_ssl_warnings = True
+max_paging_size = 1200
+#
+# Definitions of the Coco Pharmaceuticals Environment
+#
+
+# These are the three main platforms used to run Egeria's OMAG Servers
+corePlatformURL = os.environ.get("corePlatformURL", "https://localhost:9443")
+corePlatformName = "Core Platform"
+
+dataLakePlatformURL = os.environ.get("dataLakePlatformURL", "https://localhost:9443")
+dataLakePlatformName = "Data Lake Platform"
+
+devPlatformURL = os.environ.get("devPlatformURL", "https://localhost:9443")
+devPlatformName = "Dev Platform"
+
+
+# The OMAG Server Platforms host one to many OMAG Servers.  An OMAG Server could be
+# a metadata server or a specialized governance server.  Its behavior is determined
+# by a configuration document that defines which OMAG services are activated.
+# All OMAG Server Platforms support the administration md_commands to define a server's
+# configuration document.  It is also possible to create configuration documents
+# through admin calls to one OMAG Server Platform and then deploy them to the
+# OMAG Server Platform where they are to run.  In the Egeria hands on lab, the
+# OMAG Server configuration is created on the dev platform and deployed to the
+# production platforms as needed.
+
+adminPlatformURL = devPlatformURL
+
+# Gary Geeke is the IT Administration Lead at Coco Pharmaceuticals.
+# He does all of the configuration for the OMAG Servers. Other users are introduced and make
+# calls to the server as required
+
+adminUserId = "garygeeke"
+petersUserId = "peterprofile"
+erinsUserId = "erinoverview"
+calliesUserId = "calliequartile"
+faithsUserId = "faithbroker"
+harrysUserId = "harryhopeful"
+
+# These are the names of the metadata servers used by Coco Pharmaceuticals.  Each metadata
+# server runs as an OMAG Server on one of the OMAG Server Platforms
+
+cocoMDS1PlatformURL = dataLakePlatformURL
+cocoMDS1PlatformName = dataLakePlatformName
+cocoMDS1Name = "cocoMDS1"
+
+cocoMDS2PlatformURL = corePlatformURL
+cocoMDS2PlatformName = corePlatformName
+cocoMDS2Name = "cocoMDS2"
+
+cocoMDS3PlatformURL = corePlatformURL
+cocoMDS3PlatformName = corePlatformName
+cocoMDS3Name = "cocoMDS3"
+
+cocoMDS4PlatformURL = dataLakePlatformURL
+cocoMDS4PlatformName = dataLakePlatformName
+cocoMDS4Name = "cocoMDS4"
+
+cocoMDS5PlatformURL = corePlatformURL
+cocoMDS5PlatformName = corePlatformName
+cocoMDS5Name = "cocoMDS5"
+
+cocoMDS6PlatformURL = corePlatformURL
+cocoMDS6PlatformName = corePlatformName
+cocoMDS6Name = "cocoMDS6"
+
+cocoMDSxPlatformURL = devPlatformURL
+cocoMDSxPlatformName = devPlatformName
+cocoMDSxName = "cocoMDSx"
+
+cocoOLS1PlatformName = dataLakePlatformName
+cocoOLS1PlafformURL = dataLakePlatformURL
+cocoOLS1Name = "cocoOLS1"
+
+# The open metadata servers are linked together through the following open metadata cohorts.
+# The servers linked via a cohort can exchange open metadata either through federated
+# queries or metadata replication.
+
+cocoCohort = "cocoCohort"
+devCohort = "devCohort"
+iotCohort = "iotCohort"
+ctsCohort = "ctsCohort"
+
+# This is the view server that runs the services that support Egeria's user interface.
+
+cocoView1PlatformURL = dataLakePlatformURL
+cocoView1PlatformName = dataLakePlatformName
+cocoView1Name = "cocoView1"
+
+# These are the names of the governance servers used in Coco Pharmaceuticals' data lake.
+# Each governance server runs as an OMAG Server on the Data Lake OMAG Server Platform.
+# They also connect to a metadata server to retrieve their configuration and store their
+# results.
+
+governDL01PlatformURL = dataLakePlatformURL
+governDL01PlatformName = dataLakePlatformName
+governDL01Name = "governDL01"
+governDL01ServerType = "Engine Host"
+governDL01MDS = "cocoMDS1"
+
+exchangeDL01PlatformURL = dataLakePlatformURL
+exchangeDL01PlatformName = dataLakePlatformName
+exchangeDL01Name = "exchangeDL01"
+exchangeDL01ServerType = "Integration Daemon"
+exchangeDL01MDS = "cocoMDS1"
+
+monitorGov01PlatformURL = dataLakePlatformURL
+monitorGov01PlatformName = dataLakePlatformName
+monitorGov01Name = "monitorGov01"
+monitorGov01ServerType = "Integration Daemon"
+monitorGov01MDS = "cocoMDS1"
+
+monitorDev01PlatformURL = devPlatformURL
+monitorDev01PlatformName = devPlatformName
+monitorDev01Name = "monitorDev01"
+monitorDev01ServerType = "Integration Daemon"
+monitorDev01MDS = "cocoMDSx"

examples/Jupyter Notebooks/common/orig_globals.py

@@ -0,0 +1,152 @@
+#
+# This file contains the common functions and definitions used in all Egeria Hands on
+# Lab Notebooks. Typically these will be system-wide functions and common environment settings
+#
+
+
+#
+# Disable certificate checking for local development use with self-signed certificate
+#
+
+import urllib3
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+import os
+
+os.environ["CURL_CA_BUNDLE"] = ""
+
+#
+# This is the location of the file system that is used in the lab.  It defaults to a "data" subfolder in
+# the platform's home folder.  Here you will finc the runtime files of the platforms and the data files
+# used in various labs.  The default value can be overridden using the "fileSystemRoot" environment variable.
+#
+fileSystemRoot = os.environ.get("fileSystemRoot", "data")
+#
+# This is directory where the sample data from the Egeria distribution has been unpacked in.  The default value
+# describes its location in an IntelliJ workspace.  The default value can be overridden using the "egeriaDistributionRoot"
+# environment variable.
+#
+egeriaSampleDataRoot = os.environ.get("egeriaSampleDataRoot", ".")
+#
+# Flag to enable debug, this cases extra information to be printed including rest calls request and response details
+# Switching this flag to True produces a very large amount of output and is not recommended.
+# A targeted use of this flag is recommended, set this before and reset this after the code you would like to produce debug
+#
+isDebug = False
+#
+# Definitions of the Coco Pharmaceuticals Environment
+#
+
+# These are the three main platforms used to run Egeria's OMAG Servers
+corePlatformURL = os.environ.get("corePlatformURL", "https://localhost:9443")
+corePlatformName = "Core Platform"
+
+dataLakePlatformURL = os.environ.get("dataLakePlatformURL", "https://localhost:9444")
+dataLakePlatformName = "Data Lake Platform"
+
+devPlatformURL = os.environ.get("devPlatformURL", "https://localhost:9445")
+devPlatformName = "Dev Platform"
+
+
+# The OMAG Server Platforms host one to many OMAG Servers.  An OMAG Server could be
+# a metadata server or a specialized governance server.  Its behavior is determined
+# by a configuration document that defines which OMAG services are activated.
+# All OMAG Server Platforms support the administration md_commands to define a server's
+# configuration document.  It is also possible to create configuration documents
+# through admin calls to one OMAG Server Platform and then deploy them to the
+# OMAG Server Platform where they are to run.  In the Egeria hands on lab, the
+# OMAG Server configuration is created on the dev platform and deployed to the
+# production platforms as needed.
+
+adminPlatformURL = devPlatformURL
+
+# Gary Geeke is the IT Administration Lead at Coco Pharmaceuticals.
+# He does all of the configuration for the OMAG Servers. Other users are introduced and make
+# calls to the server as required
+
+adminUserId = "garygeeke"
+petersUserId = "peterprofile"
+erinsUserId = "erinoverview"
+calliesUserId = "calliequartile"
+faithsUserId = "faithbroker"
+harrysUserId = "harryhopeful"
+
+# These are the names of the metadata servers used by Coco Pharmaceuticals.  Each metadata
+# server runs as an OMAG Server on one of the OMAG Server Platforms
+
+cocoMDS1PlatformURL = dataLakePlatformURL
+cocoMDS1PlatformName = dataLakePlatformName
+cocoMDS1Name = "cocoMDS1"
+
+cocoMDS2PlatformURL = corePlatformURL
+cocoMDS2PlatformName = corePlatformName
+cocoMDS2Name = "cocoMDS2"
+
+cocoMDS3PlatformURL = corePlatformURL
+cocoMDS3PlatformName = corePlatformName
+cocoMDS3Name = "cocoMDS3"
+
+cocoMDS4PlatformURL = dataLakePlatformURL
+cocoMDS4PlatformName = dataLakePlatformName
+cocoMDS4Name = "cocoMDS4"
+
+cocoMDS5PlatformURL = corePlatformURL
+cocoMDS5PlatformName = corePlatformName
+cocoMDS5Name = "cocoMDS5"
+
+cocoMDS6PlatformURL = corePlatformURL
+cocoMDS6PlatformName = corePlatformName
+cocoMDS6Name = "cocoMDS6"
+
+cocoMDSxPlatformURL = devPlatformURL
+cocoMDSxPlatformName = devPlatformName
+cocoMDSxName = "cocoMDSx"
+
+cocoOLS1PlatformName = dataLakePlatformName
+cocoOLS1PlafformURL = dataLakePlatformURL
+cocoOLS1Name = "cocoOLS1"
+
+# The open metadata servers are linked together through the following open metadata cohorts.
+# The servers linked via a cohort can exchange open metadata either through federated
+# queries or metadata replication.
+
+cocoCohort = "cocoCohort"
+devCohort = "devCohort"
+iotCohort = "iotCohort"
+ctsCohort = "ctsCohort"
+
+# This is the view server that runs the services that support Egeria's user interface.
+
+cocoView1PlatformURL = dataLakePlatformURL
+cocoView1PlatformName = dataLakePlatformName
+cocoView1Name = "cocoView1"
+
+# These are the names of the governance servers used in Coco Pharmaceuticals' data lake.
+# Each governance server runs as an OMAG Server on the Data Lake OMAG Server Platform.
+# They also connect to a metadata server to retrieve their configuration and store their
+# results.
+
+governDL01PlatformURL = dataLakePlatformURL
+governDL01PlatformName = dataLakePlatformName
+governDL01Name = "governDL01"
+governDL01ServerType = "Engine Host"
+governDL01MDS = "cocoMDS1"
+
+exchangeDL01PlatformURL = dataLakePlatformURL
+exchangeDL01PlatformName = dataLakePlatformName
+exchangeDL01Name = "exchangeDL01"
+exchangeDL01ServerType = "Integration Daemon"
+exchangeDL01MDS = "cocoMDS1"
+
+monitorGov01PlatformURL = dataLakePlatformURL
+monitorGov01PlatformName = dataLakePlatformName
+monitorGov01Name = "monitorGov01"
+monitorGov01ServerType = "Integration Daemon"
+monitorGov01MDS = "cocoMDS1"
+
+monitorDev01PlatformURL = devPlatformURL
+monitorDev01PlatformName = devPlatformName
+monitorDev01Name = "monitorDev01"
+monitorDev01ServerType = "Integration Daemon"
+monitorDev01MDS = "cocoMDSx"