iris-pex-embedded-python 2.3.27b2__py3-none-any.whl → 3.2.1b2__py3-none-any.whl

iop/cls/IOP/Utils.cls

@@ -0,0 +1,378 @@
+/* Copyright (c) 2021 by InterSystems Corporation.
+   Cambridge, Massachusetts, U.S.A.  All rights reserved.
+   Confidential property of InterSystems Corporation. */
+
+Include Ensemble
+
+Class IOP.Utils Extends %RegisteredObject
+{
+
+ClassMethod dispatchRegisterComponent(
+	pModule As %String,
+	pRemoteClassname As %String,
+	pCLASSPATHS As %String = "",
+	pFullpath As %String = "",
+	pOverwrite As %Boolean = 0,
+	pProxyClassname As %String = "") As %Status
+{
+	set tSc = $$$OK
+	$$$ThrowOnError(##class(IOP.Utils).RegisterComponent(pModule, pRemoteClassname, pCLASSPATHS, pFullpath, pOverwrite , pProxyClassname))
+	return tSc
+}
+
+/// "bo","Duplex","/irisdev/app/src/python/demo/duplex/",1,"Duplex.Duplex"
+ClassMethod RegisterComponent(
+	pModule As %String,
+	pRemoteClassname As %String,
+	pCLASSPATHS As %String = "",
+	pFullpath As %String = "",
+	pOverwrite As %Boolean = 0,
+	pProxyClassname As %String = "") As %Status
+{
+	#dim tSC As %Status = $$$OK
+	#dim ex As %Exception.AbstractException
+	#dim tLanguage,tExtraClasspaths,tDelimiter,tOnePath As %String = ""
+	#dim tClassDetails,tRemoteSettings As %String = ""
+	#dim tClasspaths As %ListOfDataTypes
+	
+	Quit:(""=pRemoteClassname) $$$ERROR($$$EnsErrGeneral,"Remote Classname must be specified in order to register a Production EXtensions component")
+	Quit:(""=pModule) $$$ERROR($$$EnsErrGeneral,"Must specify the module of the remote code.")
+		
+	Try {
+
+		$$$ThrowOnError(..GetRemoteClassInfo(pRemoteClassname,pModule,pCLASSPATHS,pFullpath,.tClassDetails,.tRemoteSettings))
+
+		Set tConnectionSettings("Classpaths") = pCLASSPATHS
+		Set tConnectionSettings("Module") = pModule
+		Set tConnectionSettings("Classname") = pRemoteClassname
+		Set:(""=pProxyClassname) pProxyClassname = "User."_pRemoteClassname
+		
+		$$$ThrowOnError(..GenerateProxyClass(pProxyClassname,.tConnectionSettings,tClassDetails,tRemoteSettings,pOverwrite))
+
+	} Catch ex {
+		set msg = $System.Status.GetOneStatusText(ex.AsStatus(),1)
+		set tSC = $$$ERROR($$$EnsErrGeneral,msg)
+	}
+
+	Quit tSC
+}
+
+ClassMethod DeleteComponentProxy(pClassname As %String = "") As %Status
+{
+	#dim tSC As %Status = $$$OK
+	#dim ex As %Exception.AbstractException
+	#dim tIsPEX As %Boolean = 0
+	#dim tClass As %Dictionary.CompiledClass
+	
+	Quit:(""=pClassname) $$$ERROR($$$EnsErrGeneral,"Remote class name must be specified.")
+	
+	Try {
+		
+		If '##class(%Dictionary.ClassDefinition).%ExistsId(pClassname) {
+			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("No proxy class defined for remote class '%1'.",pClassname))
+			Quit
+		}
+		If $classmethod(pClassname,"%Extends","IOP.Common") {
+			Set tClass = ##class(%Dictionary.CompiledClass).%OpenId(pClassname,,.tSC)
+			Quit:$$$ISERR(tSC)
+			If '$IsObject(tClass) {
+				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class for remote class '%1' could not be opened.",pClassname))
+				Quit
+			}
+			Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+		}
+		If tIsPEX {
+			Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
+			If $$$ISERR(tSC) {
+				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete proxy class for remote class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
+				Quit
+			}
+		} Else {
+			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot delete class '%1' because it is not a PEX proxy class.",pClassname))
+			Quit
+		}
+		
+	} Catch ex {
+		Set tSC = ex.AsStatus()
+	}
+	
+	Quit tSC
+}
+
+// ..GetRemoteClassInfo(pRemoteClassname,pModule,pCLASSPATHS,.tClassDetails,.tRemoteSettings)
+
+ClassMethod GetRemoteClassInfo(
+	pRemoteClassname As %String,
+	pModule As %String,
+	pClasspaths As %String,
+	pFullpath As %String = "",
+	ByRef pClassDetails,
+	ByRef pRemoteSettings) As %Status [ Internal ]
+{
+	#dim tSC As %Status = $$$OK
+	#dim ex As %Exception.AbstractException
+	
+	Try {
+		if pClasspaths '="" {
+			set sys = ##class(%SYS.Python).Import("sys")
+			set delimiter = $s($system.Version.GetOS()="Windows":";",1:":")
+			set extraClasspaths = $tr(pClasspaths,delimiter,"|")
+			for i=1:1:$l(extraClasspaths,"|") {
+				set onePath = $p(extraClasspaths,"|",i)
+				set onePath = ##class(%File).NormalizeDirectory(onePath)
+				if onePath?1"$$IRISHOME"1P.E set onePath = $e($system.Util.InstallDirectory(),1,*-1)_$e(onePath,11,*)
+				if onePath'="" do ##class(IOP.Common).SetPythonPath(onePath)
+			}
+		}
+
+		set importlib = ##class(%SYS.Python).Import("importlib")
+		set builtins = ##class(%SYS.Python).Import("builtins")
+		// Load the module form a specific path
+		Try {
+			set spec = importlib.util."spec_from_file_location"(pModule, pFullpath)
+			set module = importlib.util."module_from_spec"(spec)
+			do sys.modules."__setitem__"(pModule, module)
+			do spec.loader."exec_module"(module)
+		}
+		Catch ex {
+			// If the module is not found, try to import the frist one found
+			set module = importlib."import_module"(pModule)
+		}
+
+		// Get the class
+		set class = builtins.getattr(module, pRemoteClassname)
+		set tClass = class."__new__"(class)
+
+		If $IsObject(tClass) {
+			#; List of information about the class as a whole - $lb(SuperClass, Description, InfoURL, IconURL, Adapter)
+			Set pClassDetails = tClass."_get_info"()
+			#; List of information about the various properties of the class
+			#; List of lists of form $lb(propName,dataType,defaultVal,required,category,description)
+			Set pRemoteSettings = tClass."_get_properties"()
+		} Else {
+			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Error opening gateway proxy for class '%1'"),pRemoteClassname)
+		}
+	} Catch ex {
+		set msg = $System.Status.GetOneStatusText(ex.AsStatus(),1)
+		set tSC = $$$ERROR($$$EnsErrGeneral,msg)
+	}
+	
+	Quit tSC
+}
+
+ClassMethod GenerateProxyClass(
+	pClassname As %String,
+	ByRef pConnectionSettings,
+	pClassDetails As %String = "",
+	pRemoteSettings As %String = "",
+	pOverwrite As %Boolean = 0) As %Status [ Internal, Private ]
+{
+	#dim tSC As %Status = $$$OK
+	#dim ex As %Exception.AbstractException
+	
+	Quit:(""=pClassname) $$$ERROR($$$EnsErrGeneral,"Class name must be specified in order to generate a proxy class for this Production EXtensions component")
+	
+	Try {
+
+		If ##class(%Dictionary.ClassDefinition).%ExistsId(pClassname) {
+			If 'pOverwrite {
+				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class '%1' already exists.",pClassname))
+				Quit
+			} Else {
+				#dim tIsPEX As %Boolean = 0
+				If $classmethod(pClassname,"%Extends","IOP.Common") {
+					#dim tClass As %Dictionary.CompiledClass = ##class(%Dictionary.CompiledClass).%OpenId(pClassname)
+					If '$IsObject(tClass) {
+						Set tSC = $$$ERROR($$$EnsErrGeneral,"Class not found")
+						Quit
+					}
+					Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+				}
+				If tIsPEX {
+					Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
+					If $$$ISERR(tSC) {
+						Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete existing proxy class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
+						Quit
+					}
+				} Else {
+					Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot overwrite class '%1' because it is not a PEX proxy class.",pClassname))
+					Quit
+				}
+			}
+		}
+		
+		#; create subclass of the ObjectScript Business Host
+		#dim tCOSClass As %Dictionary.ClassDefinition
+		Set tCOSClass = ##class(%Dictionary.ClassDefinition).%New()
+		Set tCOSClass.Name = pClassname
+
+		#dim tSuperClass As %String = pClassDetails."__getitem__"(0)
+		If (""=tSuperClass) {
+			Set tSC = $$$ERROR($$$EnsErrGeneral,"No PEX superclass found.")
+			Quit
+		}
+		If '$Case($P(tSuperClass,".",*),"DuplexProcess":1,"DuplexService":1,"DuplexOperation":1,"InboundAdapter":1,"OutboundAdapter":1,"BusinessService":1,"BusinessProcess":1,"BusinessOperation":1,:0) {
+			Set tSC = $$$ERROR($$$EnsErrGeneral,"Invalid superclass")
+			Quit
+		}
+		Set tSuperClass = "IOP."_$P(tSuperClass,".",*)
+		
+		Set tCOSClass.Super = tSuperClass
+		Set tCOSClass.GeneratedBy = $CLASSNAME()
+		Set tCOSClass.ClassVersion = $$$CLASSDEFINITIONVERSION
+		#dim tDescription As %String = pClassDetails."__getitem__"(1)
+		If (""'=tDescription) {
+			Set tCOSClass.Description = $Replace(tDescription,$C(10),$C(13,10))
+		}
+		
+		#; Do not display any of the connection settings
+		#dim tSETTINGSParamValue As %String = "%classname:Python $type,%module:Python $type,%settings:Python $type,%classpaths:Python $type"
+		
+		#dim tPropClassname As %Dictionary.PropertyDefinition = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropClassname.Name = "%classname"
+		Set tPropClassname.Type = "%String"
+		Set tPropClassname.InitialExpression = $$$quote(pConnectionSettings("Classname"))
+		Set tPropClassname.Internal = 1
+		Set tSC = tCOSClass.Properties.Insert(tPropClassname)
+		Quit:$$$ISERR(tSC)
+		
+		
+		#dim tPropClasspaths As %Dictionary.PropertyDefinition = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropClasspaths.Name = "%classpaths"
+		Set tPropClasspaths.Type = "%String"
+		Set tSC = tPropClasspaths.Parameters.SetAt("","MAXLEN")
+		Quit:$$$ISERR(tSC)
+		Set tPropClasspaths.InitialExpression = $$$quote(pConnectionSettings("Classpaths"))
+		Set tPropClasspaths.Description = "One or more Classpaths (separated by '|' character) needed in addition to the ones configured in the Remote Gateway"
+		Set tSC = tCOSClass.Properties.Insert(tPropClasspaths)
+		Quit:$$$ISERR(tSC)
+		
+		
+		#dim tPropLanguage As %Dictionary.PropertyDefinition = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropLanguage.Name = "%module"
+		Set tPropLanguage.Type = "%String"
+		Set tPropLanguage.Internal = 1
+		Set tPropLanguage.InitialExpression = $$$quote(pConnectionSettings("Module"))
+		Set tSC = tCOSClass.Properties.Insert(tPropLanguage)
+		Quit:$$$ISERR(tSC)
+		
+		If $Case(tSuperClass,"IOP.BusinessService":1,"IOP.BusinessOperation":1,"IOP.DuplexService":1,"IOP.DuplexOperation":1,:0) {
+			set builtins = ##class(%SYS.Python).Import("builtins")
+			If (builtins.len(pClassDetails)>4) { //Adaptor
+
+				#dim tAdapterClass = pClassDetails."__getitem__"(4)
+				#; May want to issue a warning in the UI if the Adapter class does not exist
+				#; but we don't check here because it does compile and may just be that the user is registering the Service/Operation before the Adapter
+				#dim tADAPTERParam As %Dictionary.ParameterDefinition = ##class(%Dictionary.ParameterDefinition).%New()
+				Set tADAPTERParam.Name = "ADAPTER"
+				Set tADAPTERParam.Default = tAdapterClass
+				Set tSC = tCOSClass.Parameters.Insert(tADAPTERParam)
+				Quit:$$$ISERR(tSC)
+			}
+		}
+
+		set type = ""
+		set:($Case(tSuperClass,"IOP.InboundAdapter":1,"IOP.OutboundAdapter":1,:0)) type = "Adapter"
+		set tSETTINGSParamValue = $REPLACE(tSETTINGSParamValue,"$type",type)
+		
+		#dim tSETTINGSParam As %Dictionary.ParameterDefinition = ##class(%Dictionary.ParameterDefinition).%New()
+		Set tSETTINGSParam.Name = "SETTINGS"
+		Set tSETTINGSParam.Default = tSETTINGSParamValue
+		Set tSC = tCOSClass.Parameters.Insert(tSETTINGSParam)
+		Quit:$$$ISERR(tSC)
+		
+		Set tSC = tCOSClass.%Save()
+		Quit:$$$ISERR(tSC)
+		
+		Set tSC = $System.OBJ.Compile(pClassname,"-d")
+		
+	} Catch ex {
+		Set tSC = ex.AsStatus()
+	}
+	
+	Quit tSC
+}
+
+ClassMethod CreateProduction(
+	package As %String = "test",
+	name As %String = "AutoCreatedProduction",
+	xdata As %CharacterStream) As %Status
+{
+  #Dim produtionClassName As %String = package _ "." _ name
+  If ('$ZName(produtionClassName, 4))
+  {
+  Return $System.Status.Error(5001, "Invalid Production package or name.")
+  }
+  #Dim productionDefinition As %Dictionary.ClassDefinition
+  // Check if the production already exists
+  If (##class(%Dictionary.ClassDefinition).%ExistsId(produtionClassName))
+  {
+	// Open the production
+	set productionDefinition = ##class(%Dictionary.ClassDefinition).%OpenId(produtionClassName)
+  }
+  Else
+  {
+	// Create the production definition
+    set productionDefinition = ##Class(%Dictionary.ClassDefinition).%New()
+  }
+  //
+  Set productionDefinition.Name         = produtionClassName
+  Set productionDefinition.Super        = "Ens.Production"
+  Set productionDefinition.ClassVersion = 25
+  //
+  // Check if the XData Definition already exists
+  If (##Class(%Dictionary.XDataDefinition).%ExistsId(produtionClassName_"||ProductionDefinition"))
+  {
+	// delete the XData Definition
+	$$$ThrowOnError(##Class(%Dictionary.XDataDefinition).%DeleteId(produtionClassName_"||ProductionDefinition"))
+  }
+  #Dim xdataDefinition As %Dictionary.XDataDefinition = ##Class(%Dictionary.XDataDefinition).%New()
+  //
+  Set xdataDefinition.Name = "ProductionDefinition"
+  //
+  Do xdataDefinition.Data.CopyFrom(xdata)
+  //
+  // Insert XData Definition into Production Definition
+  Do productionDefinition.XDatas.Insert(xdataDefinition)
+  //
+  #Dim statusCode As %Status = productionDefinition.%Save()
+  //
+  If ($System.Status.IsError(statusCode))
+  {
+  Return statusCode
+  }
+  // Compile the production class
+  return $System.OBJ.Compile(produtionClassName,"k-d")
+}
+
+/// Export a production to an XML string
+ClassMethod ExportProduction(pProductionName As %String) As %String
+{
+	Set sc = $$$OK
+	set xdata = ""
+	// Check if the XData Definition exists
+	If (##Class(%Dictionary.XDataDefinition).%ExistsId(pProductionName_"||ProductionDefinition"))
+	{
+		// Open the XData Definition
+		Set xdataDefinition = ##Class(%Dictionary.XDataDefinition).%OpenId(pProductionName_"||ProductionDefinition")
+		Set xdata = xdataDefinition.Data
+	}
+	Else
+	{
+		$$$ThrowOnError($System.Status.Error(5001, "Production does not exist."))
+	}
+	Return xdata
+}
+
+ClassMethod dispatchTestComponent(
+	pTargetName As %String,
+	pInput As Ens.Request) As Ens.Response
+{
+    #dim tService as EnsLib.Testing.Service
+	set tOutput = ""
+    $$$ThrowOnError(##class(Ens.Director).CreateBusinessService("EnsLib.Testing.Service", .tService))
+    $$$ThrowOnError(tService.SendTestRequest(pTargetName, pInput, .tOutput, .sessionID , 1))
+	Quit tOutput
+}
+
+}

iop/wsgi/handlers.py

@@ -0,0 +1,104 @@
+import os, sys, importlib, urllib.parse
+from io import BytesIO
+
+__ospath = os.getcwd()
+
+import iris
+
+os.chdir(__ospath)
+
+enc, esc = sys.getfilesystemencoding(), 'surrogateescape'
+
+rest_service = iris.cls('%REST.Impl')
+
+def get_from_module(app_path, app_module, app_name):
+
+    # Add the path to the application
+    if (app_path not in sys.path) :
+        sys.path.append(app_path)
+
+    # retrieve the application
+    return getattr(importlib.import_module(app_module), app_name)
+
+# Changes the current working directory to the manager directory of the instance.
+def goto_manager_dir():
+    iris.system.Process.CurrentDirectory(iris.system.Util.ManagerDirectory())
+
+def unicode_to_wsgi(u):
+    # Convert an environment variable to a WSGI "bytes-as-unicode" string
+    return u.encode(enc, esc).decode('iso-8859-1')
+
+def wsgi_to_bytes(s):
+    return s.encode('iso-8859-1')
+
+def write(chunk):
+    rest_service._WriteResponse(chunk)
+
+def start_response(status, response_headers, exc_info=None):
+    '''WSGI start_response callable'''
+    if exc_info:
+        try:
+            raise exc_info[1].with_traceback(exc_info[2])
+        finally:
+            exc_info = None
+
+    rest_service._SetStatusCode(status)
+    for tuple in response_headers:
+        rest_service._SetHeader(tuple[0], tuple[1])
+    return write
+
+
+# Make request to application
+def make_request(environ, stream, application, path):
+
+    # Change the working directory for logging purposes
+    goto_manager_dir()
+
+    error_log_file = open('WSGI.log', 'a+')
+    
+    # We want the working directory to be the app's directory
+    if (not path.endswith(os.path.sep)):
+        path = path + os.path.sep
+
+    #iris.system.Process.CurrentDirectory(path)
+    
+    # Set up the body of the request
+    if stream != '':
+        bytestream = stream
+    elif (environ['CONTENT_TYPE'] == 'application/x-www-form-urlencoded'):
+        bytestream = BytesIO()
+        part = urllib.parse.urlencode(environ['formdata'])
+        bytestream.write(part.encode('utf-8'))
+        bytestream.seek(0)
+    else:
+        bytestream = BytesIO(b'')
+
+    #for k,v in os.environ.items():
+        #environ[k] = unicode_to_wsgi(v)
+    environ['wsgi.input'] = bytestream   
+    environ['wsgi.errors'] = error_log_file
+    environ['wsgi.version']      = (1, 0)
+    environ['wsgi.multithread']  = False
+    environ['wsgi.multiprocess'] = True
+    environ['wsgi.run_once']     = True
+
+
+    if environ.get('HTTPS', 'off') in ('on', '1'):
+        environ['wsgi.url_scheme'] = 'https'
+    else:
+        environ['wsgi.url_scheme'] = 'http'
+    
+    # Calling WSGI application
+    response = application(environ, start_response)
+
+    error_log_file.close()
+
+    try:
+        for data in response:
+            if data:
+                # (REST.Impl).Write() needs a utf-8 string
+                write(data.decode('utf-8'))
+            write(b'')
+    finally:
+        if hasattr(response, 'close'):
+            response.close()

iris_pex_embedded_python-3.2.1b2.dist-info/METADATA

@@ -0,0 +1,90 @@
+Metadata-Version: 2.2
+Name: iris_pex_embedded_python
+Version: 3.2.1b2
+Summary: Iris Interoperability based on Embedded Python
+Author-email: grongier <guillaume.rongier@intersystems.com>
+License: MIT License
+        
+        Copyright (c) 2019 InterSystems Developer Community
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://github.com/grongierisc/interoperability-embedded-python
+Project-URL: documentation, https://github.com/grongierisc/interoperability-embedded-python/blob/master/README.md
+Project-URL: repository, https://github.com/grongierisc/interoperability-embedded-python
+Project-URL: issues, https://github.com/grongierisc/interoperability-embedded-python/issues
+Keywords: iris,intersystems,python,embedded
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dacite>=1.6.0
+Requires-Dist: xmltodict>=0.12.0
+Requires-Dist: iris-embedded-python-wrapper>=0.0.6
+Requires-Dist: setuptools>=40.8.0
+Requires-Dist: dc-schema>=0.0.8
+Requires-Dist: jsonpath-ng>=1.7.0
+
+# IoP (Interoperability On Python)
+
+[![PyPI - Status](https://img.shields.io/pypi/status/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
+[![PyPI](https://img.shields.io/pypi/v/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
+[![PyPI - License](https://img.shields.io/pypi/l/iris-pex-embedded-python)](https://pypi.org/project/iris-pex-embedded-python/)
+![GitHub last commit](https://img.shields.io/github/last-commit/grongierisc/interoperability-embedded-python)
+
+Welcome to the **Interoperability On Python (IoP)** proof of concept! This project demonstrates how the **IRIS Interoperability Framework** can be utilized with a **Python-first approach**.
+
+Documentation can be found [here](https://grongierisc.github.io/interoperability-embedded-python/).
+
+## Example
+
+Here's a simple example of how a Business Operation can be implemented in Python:
+
+```python
+from iop import BusinessOperation
+
+class MyBo(BusinessOperation):
+    def on_message(self, request):
+        self.log_info("Hello World")
+```
+
+## Installation
+
+To start using this proof of concept, install it using pip:
+
+```bash
+pip install iris-pex-embedded-python
+```
+
+## Getting Started
+
+If you're new to this project, begin by reading the [installation guide](https://grongierisc.github.io/interoperability-embedded-python/getting-started/installation). Then, follow the [first steps](https://grongierisc.github.io/interoperability-embedded-python/getting-started/first-steps) to create your first Business Operation.
+
+Happy coding!