@planqk/planqk-api-sdk 1.6.0 → 1.9.0

package/.env.template

@@ -1,3 +1,3 @@
-PLANQK_API_BASE_URL=https://platform.planqk.de/qc-catalog
-PLANQK_PERSONAL_ACCESS_TOKEN=
-PLANQK_ORGANIZATION_ID=
+KQH_BASE_URL=https://api.hub.kipu-quantum.com/qc-catalog
+KQH_PERSONAL_ACCESS_TOKEN=
+KQH_ORGANIZATION_ID=

package/.gitlab-ci.yml

@@ -26,10 +26,6 @@ compile-node-sdk:
     - npm ci
   script:
     - npm run build
-  artifacts:
-    expire_in: 1 hour
-    paths:
-      - dist
   cache:
     key: node_modules
     paths:
@@ -77,6 +73,8 @@ publish-python-sdk:
     - if: '$CI_COMMIT_TAG'
   image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
   before_script:
+    - uv venv
+    - uv sync --frozen
     - source .venv/bin/activate
     - uv pip install twine
   script:
@@ -94,6 +92,11 @@ publish-node-sdk:
   rules:
     - if: '$CI_COMMIT_TAG'
   image: node:lts
+  id_tokens:
+    NPM_ID_TOKEN:
+      aud: "npm:registry.npmjs.org"
+    SIGSTORE_ID_TOKEN:
+      aud: sigstore
   before_script:
     - npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
   script:
@@ -101,10 +104,6 @@ publish-node-sdk:
     - cp README-node.md README.md
     - npm run build
     - npm publish
-  artifacts:
-    expire_in: 1 hour
-    paths:
-      - dist
   cache:
     key: node_modules
     paths:

package/README-node.md

@@ -10,4 +10,4 @@ npm install @planqk/planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/README-python.md

@@ -10,4 +10,4 @@ pip install --upgrade planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/README.md

@@ -10,4 +10,4 @@ npm install @planqk/planqk-api-sdk
 
 ## Usage
 
-The usage docs are available at <https://docs.planqk.de/sdk-api-reference.html>.
+The usage docs are available at <https://docs.hub.kipu-quantum.com/sdk-api-reference.html>.

package/dist/sdk/environments.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare const PlanqkApiEnvironment: {
-    readonly Default: "https://platform.planqk.de/qc-catalog";
+    readonly Default: "https://api.hub.kipu-quantum.com/qc-catalog";
 };
 export type PlanqkApiEnvironment = typeof PlanqkApiEnvironment.Default;

package/dist/sdk/environments.js

@@ -5,5 +5,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkApiEnvironment = void 0;
 exports.PlanqkApiEnvironment = {
-    Default: "https://platform.planqk.de/qc-catalog",
+    Default: "https://api.hub.kipu-quantum.com/qc-catalog",
 };

package/fern/openapi/openapi.json

@@ -12,7 +12,7 @@
   },
   "servers": [
     {
-      "url": "https://platform.planqk.de/qc-catalog",
+      "url": "https://api.hub.kipu-quantum.com/qc-catalog",
       "description": "Platform API URL"
     }
   ],

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@planqk/planqk-api-sdk",
-  "version": "1.6.0",
+  "version": "1.9.0",
   "description": "SDK to interact with the official PLANQK API.",
   "author": "Kipu Quantum GmbH",
   "contributors": [
+    "Harzenetter, Lukas <lukas.harzenetter@kipu-quantum.com>",
     "Wurster, Michael <michael.wurster@kipu-quantum.com>"
   ],
   "license": "Apache-2.0",

package/planqk/api/_version.py

@@ -1 +1 @@
-__version__ = "1.6.0"
+__version__ = "1.9.0"

package/planqk/api/client.py

@@ -7,12 +7,12 @@ from planqk.api.credentials import DefaultCredentialsProvider
 from planqk.api.sdk import PlanqkApi
 from planqk.api.sdk.data_pools.client import DataPoolsClient
 
-_PLANQK_API_BASE_URL_NAME = "PLANQK_API_BASE_URL"
+_BASE_URL = "KQH_BASE_URL"
 
 
 class PlanqkApiClient:
     def __init__(self, access_token: Optional[str] = None, organization_id: Optional[str] = None):
-        base_url = os.environ.get(_PLANQK_API_BASE_URL_NAME, "https://platform.planqk.de/qc-catalog")
+        base_url = os.environ.get(_BASE_URL, "https://api.hub.kipu-quantum.com/qc-catalog")
         credentials_provider = DefaultCredentialsProvider(access_token)
 
         self.api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)

package/planqk/api/credentials.py

@@ -4,8 +4,8 @@ import platform
 from abc import ABC, abstractmethod
 from json import JSONDecodeError
 
-_PERSONAL_ACCESS_TOKEN_NAME = "PLANQK_PERSONAL_ACCESS_TOKEN"
-_CONFIG_FILE_PATH = "PLANQK_CONFIG_FILE_PATH"
+_PERSONAL_ACCESS_TOKEN = "KQH_PERSONAL_ACCESS_TOKEN"
+_CONFIG_FILE_PATH = "KQH_CONFIG_FILE_PATH"
 
 
 class CredentialUnavailableError(Exception):
@@ -15,7 +15,7 @@ class CredentialUnavailableError(Exception):
 
     def __init__(self, message=None):
         if message is None:
-            message = f"Credentials not found. Please set your personal access token as parameter, in the environment, or use 'planqk login' to authenticate."
+            message = "Credentials not found. Please set your personal access token as parameter, in the environment, or use 'planqk login' to authenticate."
         super().__init__(message)
 
 
@@ -29,10 +29,10 @@ class CredentialProvider(ABC):
 class EnvironmentCredential(CredentialProvider):
 
     def get_access_token(self) -> str:
-        access_token = os.environ.get(_PERSONAL_ACCESS_TOKEN_NAME)
+        access_token = os.environ.get(_PERSONAL_ACCESS_TOKEN)
 
         if not access_token:
-            raise CredentialUnavailableError(f"Environment variable {_PERSONAL_ACCESS_TOKEN_NAME} is not set")
+            raise CredentialUnavailableError(f"Environment variable {_PERSONAL_ACCESS_TOKEN} is not set")
 
         return access_token
 
@@ -80,7 +80,7 @@ class StaticCredential(CredentialProvider):
 
     def get_access_token(self) -> str:
         if not self.access_token:
-            raise CredentialUnavailableError(f"Access token not set")
+            raise CredentialUnavailableError("Access token not set")
         return self.access_token
 
 

package/planqk/api/sdk/environment.py

@@ -4,4 +4,4 @@ import enum
 
 
 class PlanqkApiEnvironment(enum.Enum):
-    DEFAULT = "https://platform.planqk.de/qc-catalog"
+    DEFAULT = "https://api.hub.kipu-quantum.com/qc-catalog"

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.6.0"
+version = "1.9.0"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
@@ -34,8 +34,8 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://kipu-quantum.com/platform"
-Documentation = "https://docs.planqk.de"
+Homepage = "https://hub.kipu-quantum.com"
+Documentation = "https://docs.hub.kipu-quantum.com"
 Repository = "https://gitlab.com/planqk-foss/planqk-api-sdk"
 Issues = "https://gitlab.com/planqk-foss/planqk-api-sdk/-/issues"
 Changelog = "https://gitlab.com/planqk-foss/planqk-api-sdk/-/releases"

package/src/index.test.ts

@@ -3,11 +3,11 @@ import {test} from 'vitest'
 import 'dotenv/config'
 import {PlanqkApiClient} from "./sdk";
 
-test.skip('integration test: data pools', {timeout: 5 * 60 * 1000}, async () => {
-  const baseUrl = process.env.PLANQK_API_BASE_URL!
-  const apiKey = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
-  const organizationId = process.env.PLANQK_ORGANIZATION_ID
+const baseUrl = process.env.KQH_BASE_URL!
+const apiKey = process.env.KQH_PERSONAL_ACCESS_TOKEN!
+const organizationId = process.env.KQH_ORGANIZATION_ID
 
+test.skip('integration test: data pools', {timeout: 5 * 60 * 1000}, async () => {
   const client = new PlanqkApiClient({baseUrl, apiKey, organizationId})
 
   const dataPools = await client.dataPools.getDataPools()
@@ -18,10 +18,6 @@ test.skip('integration test: data pools', {timeout: 5 * 60 * 1000}, async () =>
 })
 
 test.skip('integration test: service jobs', {timeout: 5 * 60 * 1000}, async () => {
-  const baseUrl = process.env.PLANQK_API_BASE_URL!
-  const apiKey = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
-  const organizationId = process.env.PLANQK_ORGANIZATION_ID
-
   const client = new PlanqkApiClient({baseUrl, apiKey, organizationId})
 
   const serviceJobs = await client.serviceJobs.getServiceJobs()

package/src/sdk/environments.ts

@@ -3,7 +3,7 @@
  */
 
 export const PlanqkApiEnvironment = {
-    Default: "https://platform.planqk.de/qc-catalog",
+    Default: "https://api.hub.kipu-quantum.com/qc-catalog",
 } as const;
 
 export type PlanqkApiEnvironment = typeof PlanqkApiEnvironment.Default;