@planqk/planqk-service-sdk 2.1.1 → 2.1.2

package/.gitlab-ci.yml

@@ -1,9 +1,5 @@
 variables:
   TWINE_USERNAME: __token__
-  DATADOG_STATIC_ANALYZER_URL: "https://github.com/DataDog/datadog-static-analyzer/releases/latest/download/datadog-static-analyzer-x86_64-unknown-linux-gnu.zip"
-  DATADOG_OSV_SCANNER_URL: "https://github.com/DataDog/osv-scanner/releases/latest/download/osv-scanner_linux_amd64.zip"
-  DATADOG_ENV: "ci"
-  DATADOG_SERVICE: "planqk-service-sdk"
   UV_VERSION: 0.6
   PYTHON_VERSION: 3.11
   BASE_LAYER: bookworm-slim
@@ -17,41 +13,6 @@ stages:
   - commit-release-check
   - release-package
 
-datadog-static-analyzer:
-  stage: commit-test
-  rules:
-    - if: '$CI_COMMIT_MESSAGE =~ /^chore\(release\):/'
-      when: never
-    - if: '$CI_PIPELINE_SOURCE == "web"'
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-  image: node:lts
-  before_script:
-    - npm install -g @datadog/datadog-ci
-    - curl -L $DATADOG_STATIC_ANALYZER_URL > /tmp/datadog-static-analyzer.zip
-    - unzip /tmp/datadog-static-analyzer.zip -d /tmp
-    - mv /tmp/datadog-static-analyzer /usr/local/datadog-static-analyzer
-  script:
-    - /usr/local/datadog-static-analyzer -i . -o /tmp/report.sarif -f sarif
-    - datadog-ci sarif upload /tmp/report.sarif --service "$DATADOG_SERVICE" --env "$DATADOG_ENV"
-
-datadog-sbom-analyzer:
-  stage: commit-test
-  rules:
-    - if: '$CI_COMMIT_MESSAGE =~ /^chore\(release\):/'
-      when: never
-    - if: '$CI_PIPELINE_SOURCE == "web"'
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-  image: node:lts
-  before_script:
-    - npm install -g @datadog/datadog-ci
-    - mkdir /osv-scanner
-    - curl -L -o /osv-scanner/osv-scanner.zip $DATADOG_OSV_SCANNER_URL
-    - unzip /osv-scanner/osv-scanner.zip -d /osv-scanner
-    - chmod 755 /osv-scanner/osv-scanner
-  script:
-    - /osv-scanner/osv-scanner --skip-git -r --experimental-only-packages --format=cyclonedx-1-5 --paths-relative-to-scan-dir --output=/tmp/sbom.json .
-    - datadog-ci sbom upload --service "$DATADOG_SERVICE" --env "$DATADOG_ENV" /tmp/sbom.json
-
 semantic-release:
   stage: commit-release-check
   rules:
@@ -59,6 +20,13 @@ semantic-release:
       when: never
     - if: '$CI_PIPELINE_SOURCE == "web"'
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+  variables:
+    ## Use the gitlab user to create the release commit
+    ## https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#git-environment-variables
+    GIT_AUTHOR_NAME: "$GITLAB_USER_NAME"
+    GIT_AUTHOR_EMAIL: "$GITLAB_USER_EMAIL"
+    GIT_COMMITTER_NAME: "$GITLAB_USER_NAME"
+    GIT_COMMITTER_EMAIL: "$GITLAB_USER_EMAIL"
   image: node:lts
   before_script:
     - apt-get update && apt-get install -y --no-install-recommends git-core ca-certificates
@@ -95,6 +63,7 @@ publish-node-sdk:
     - npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
   script:
     - npm ci
+    - cp README-node.md README.md
     - npm run build
     - npm publish
   cache:

package/README.md

@@ -1,56 +1,41 @@
-# planqk-service-sdk
+# PLANQK Service SDK
 
-This repository contains the SDK clients to execute PLANQK Managed Services.
-The clients are generated from a very general [OpenAPI](https://swagger.io/specification) description using [Fern](https://buildwithfern.com).
-The generated clients are a baseline, and the idea is to adapt and extend them to our specific needs.
+## Installation
 
-## Generate the SDK clients with Fern
-
-> <https://buildwithfern.com/docs/getting-started>
+The package can be installed using `npm`:
 
 ```bash
-npm install -g fern-api
-fern upgrade
-fern generate
+npm install @planqk/planqk-service-sdk
 ```
 
-## Python Setup
-
-To create a new virtual environment and install the dependencies, run:
+## Usage
 
-```bash
-uv venv
-source .venv/bin/activate
+```typescript
+const serviceEndpoint = "..."
+const consumerKey = "..."
+const consumerSecret = "..."
 
-uv sync
-```
+const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
 
-Update dependencies and lock files:
-
-```bash
-uv sync -U
-```
+// prepare your input data and parameters
+const data = {input: {a: 1, b: 2}};
+const params = {param1: "value1", param2: "value2"};
 
-## How to update the Python client?
+// execute the service
+let serviceExecution = await client.api().execute({data, params})
 
-After generating the SDK clients with Fern, the Python client needs to be copied manually.
+// retrieve the status of a service execution
+serviceExecution = await client.api().getStatus(serviceExecution.id!);
 
-Copy the content of `./generated/python` to `./planqk/service/sdk`.
-Make sure you overwrite any existing files.
-It is recommended to remove the old files first.
+// wait for the service execution to finish
+const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"];
+while (!finalStates.includes(serviceExecution.status!)) {
+  serviceExecution = await client.api().getStatus(serviceExecution.id!);
+}
 
-Next, check by executing `pytest` if the changes are compatible with our wrapper.
+// retrieve the result
+const result = await client.api().getResult(serviceExecution.id!)
 
-## How to update the TypeScript client?
-
-After generating the SDK clients with Fern, the TypeScript client needs to be copied manually.
-
-Copy the content of `./generated/typescript` to `./typescript/src/sdk`.
-Make sure you overwrite any existing files.
-It is recommended to remove the old files first.
-
-Next, check by executing `npm test` if the changes are compatible with our wrapper.
-
-## License
-
-Apache-2.0 | Copyright 2023-2024 Kipu Quantum GmbH
+// retrieve the logs
+const logs = await client.api().getLogs(serviceExecution.id!)
+```

package/notebooks/python-sdk.ipynb

@@ -18,6 +18,7 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "\n",
     "from dotenv import load_dotenv\n",
     "\n",
     "# Make a copy of .env.example and rename it to .env, place it in the \n",
@@ -218,7 +219,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import json\n",
     "from planqk.service.sdk.types.input_data_ref import InputDataRef\n",
     "\n",
     "# Create a client\n",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [
@@ -45,6 +45,5 @@
   "private": false,
   "publishConfig": {
     "access": "public"
-  },
-  "readme": "./README-node.md"
+  }
 }

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.1.1"
+__version__ = "2.1.2"

package/pyproject.toml

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