@planqk/planqk-service-sdk 2.3.0 → 2.4.0

package/notebooks/python-sdk.ipynb

@@ -83,6 +83,28 @@
     "print(f\"Service execution finished at '{ended_at}' with status '{status}'\")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from planqk.service.datapool import DataPoolReference\n",
+    "\n",
+    "# Prepare your input and specify which data pool to use at runtime\n",
+    "data = {\"file_to_read\": \"example.txt\"}\n",
+    "dataset = DataPoolReference(id=\"89ae42e1-9697-4742-adfb-95bf018104c3\")\n",
+    "\n",
+    "service_execution = client.run(request={\"data\": data, \"dataset\": dataset})\n",
+    "\n",
+    "# Wait for the service execution to finish (blocking)\n",
+    "service_execution.wait_for_final_state()\n",
+    "\n",
+    "status = service_execution.status\n",
+    "ended_at = service_execution.ended_at\n",
+    "print(f\"Service execution finished at '{ended_at}' with status '{status}'\")"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -192,7 +214,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.11"
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.3.0"
+__version__ = "2.4.0"

package/planqk/service/datapool.py

@@ -0,0 +1,24 @@
+import typing
+from enum import Enum
+
+import pydantic
+
+from .sdk.core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ReferenceType(str, Enum):
+    DATAPOOL = "DATAPOOL"
+
+
+class DataPoolReference(UniversalBaseModel):
+    id: str
+    ref: ReferenceType = ReferenceType.DATAPOOL
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow",
+                                                                                 frozen=True)  # type: ignore # Pydantic v2
+    else:
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-service-sdk"
-version = "2.3.0"
+version = "2.4.0"
 description = "SDK to interact with PLANQK Managed Services."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },