@planqk/planqk-api-sdk 1.9.2 → 1.9.4

package/README-node.md

@@ -1,3 +1,20 @@
+> **⚠️ DEPRECATED ⚠️**  
+> 
+> **This package has been deprecated and is no longer maintained.**
+> 
+> Please migrate to the new package: 
+> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
+> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
+> 
+> Install the new package:
+> ```bash
+> pip install qhub-api
+> # or
+> npm install @quantum-hub/qhub-api
+> ```
+
+---
+
 # PLANQK API SDK
 
 ## Installation

package/README-python.md

@@ -1,3 +1,20 @@
+> **⚠️ DEPRECATED ⚠️**  
+> 
+> **This package has been deprecated and is no longer maintained.**
+> 
+> Please migrate to the new package: 
+> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
+> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
+> 
+> Install the new package:
+> ```bash
+> pip install qhub-api
+> # or
+> npm install @quantum-hub/qhub-api
+> ```
+
+---
+
 # PLANQK API SDK
 
 ## Installation

package/README.md

@@ -1,13 +1,73 @@
-# PLANQK API SDK
+> **⚠️ DEPRECATED ⚠️**  
+> 
+> **This package has been deprecated and is no longer maintained.**
+> 
+> Please migrate to the new package: 
+> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
+> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
+> 
+> Install the new package:
+> ```bash
+> pip install qhub-api
+> # or
+> npm install @quantum-hub/qhub-api
+> ```
 
-## Installation
+---
 
-The package can be installed using `npm`:
+# planqk-api-sdk
+
+This repository contains the SDK to interact with the official PLANQK API.
+The clients are generated from a [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.
+
+## Generate the SDK clients with Fern
+
+> <https://buildwithfern.com/docs/getting-started>
 
 ```bash
-npm install @planqk/planqk-api-sdk
+npm install -g fern-api
+fern upgrade
+fern generate
 ```
 
-## Usage
+## Python Setup
+
+To create a new virtual environment and install the dependencies, run:
+
+```bash
+uv venv
+source .venv/bin/activate
+
+uv sync
+```
+
+Update dependencies and lock files:
+
+```bash
+uv sync -U
+```
+
+## How to update the Python client?
+
+After generating the SDK clients with Fern, the Python client needs to be copied manually.
+
+Copy the content of `./generated/python` to `./planqk/api/sdk`.
+Make sure you overwrite any existing files.
+It is recommended to remove the old files first.
+
+Next, check if the changes are compatible with our wrapper, e.g., by running the Jupyter notebook in the `notebooks` directory.
+
+## 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 if the changes are compatible with our wrapper, e.g., by running the `index.test.ts` file.
+
+## License
 
-The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.
+Apache-2.0 | Copyright 2025 Kipu Quantum GmbH

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-api-sdk",
-  "version": "1.9.2",
+  "version": "1.9.4",
   "description": "SDK to interact with the official PLANQK API.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/api/_version.py

@@ -1 +1 @@
-__version__ = "1.9.2"
+__version__ = "1.9.3"

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.9.2"
+version = "1.9.4"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },