@planqk/planqk-api-sdk 1.3.0 → 1.3.4

package/.fossa.yml

@@ -0,0 +1,8 @@
+version: 3
+project:
+  id: "git@gitlab.com:planqk-foss/planqk-api-sdk.git"
+  name: "Platform-API-SDK"
+  labels:
+    - "Platform"
+    - "Open Source"
+    - "PLANQK"

package/.gitlab-ci.yml

@@ -10,6 +10,8 @@ variables:
 
 stages:
   - commit-test
+  - install
+  - compliance
   - commit-release-check
   - release-package
 
@@ -21,8 +23,6 @@ semantic-release:
     - 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"
@@ -34,14 +34,39 @@ semantic-release:
   script:
     - semantic-release
 
+install:
+  stage: install
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+  script:
+    - uv sync --frozen --no-dev
+  artifacts:
+    expire_in: 1 hour
+    paths:
+      - .venv
+
+oss-compliance-check:
+  stage: compliance
+  rules:
+    - if: "$CI_COMMIT_TAG"
+  image: ubuntu:latest
+  before_script:
+    - apt-get update && apt-get install -y --no-install-recommends ca-certificates curl
+    - curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install-latest.sh | bash
+    - source .venv/bin/activate
+  script:
+    - FOSSA_REVISION=$([ -z $CI_COMMIT_TAG ] && echo $CI_COMMIT_SHA || echo $CI_COMMIT_TAG)
+    - FOSSA_BRANCH=$([ -z $CI_COMMIT_BRANCH ] && echo 'main' || echo $CI_COMMIT_BRANCH)
+    - fossa analyze -b $FOSSA_BRANCH -r $FOSSA_REVISION .
+    - fossa test -r $FOSSA_REVISION
+
 publish-python-sdk:
   stage: release-package
   rules:
     - 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:
@@ -66,7 +91,11 @@ publish-node-sdk:
     - cp README-node.md README.md
     - npm run build
     - npm publish
+  artifacts:
+    expire_in: 1 hour
+    paths:
+      - dist
   cache:
-    key: $CI_JOB_NAME
+    key: node_modules
     paths:
       - node_modules

package/apps/README.md

@@ -0,0 +1,24 @@
+# Test Applications
+
+This directory contains test applications for both TypeScript and Python SDKs.
+
+## TypeScript Test App
+
+To run the TypeScript test application:
+
+```bash
+cd ts-test-app
+npm install
+npm run start
+```
+
+## Python Test App
+
+To run the Python test application:
+
+```bash
+cd python-test-app
+uv run main.py
+```
+
+> Note: Ensure you have created a virtual environment based on the `pyproject.toml` in the root directory.

package/apps/python-test-app/main.py

@@ -15,7 +15,7 @@ def main():
 
     # Initialize client with environment variables
     client = PlanqkApiClient(
-        access_token=os.getenv("PLANQK_ACCESS_TOKEN"),
+        access_token=os.getenv("PLANQK_PERSONAL_ACCESS_TOKEN"),
         organization_id=os.getenv("PLANQK_ORGANIZATION_ID")
     )
 
@@ -64,7 +64,7 @@ def main():
     # Add a File to a Data Pool
     start_time = time.time()
     print("\nAdding a file to the Data Pool...")
-    file_to_upload = "my_file.txt"
+    file_to_upload = "../test-file.txt"
     with open(file_to_upload, "rb") as f:
         added_file = client.data_pools.add_data_pool_file(
             id=data_pool_id,
@@ -113,7 +113,7 @@ def main():
     response = client.data_pools.get_data_pool_file(data_pool_id, download_file_id)
 
     # Save the downloaded file
-    downloaded_filename = "downloaded-test-file.txt"
+    downloaded_filename = "../downloaded-test-file.txt"
     with open(downloaded_filename, "wb") as f:
         for chunk in response:
             f.write(chunk)

package/apps/test-file.txt

@@ -0,0 +1 @@
+This is a test file for the PLANQK API SDK.

package/apps/ts-test-app/index.ts

@@ -1,13 +1,13 @@
-import {PlanqkApiClient} from "@planqk/planqk-api-sdk"
+import * as dotenv from "dotenv";
 import * as fs from "fs";
 import {Readable} from "stream";
-import * as dotenv from "dotenv";
+import {PlanqkApiClient} from "@planqk/planqk-api-sdk"
 
 dotenv.config();
 
 const client = new PlanqkApiClient({
-  apiKey: process.env.PLANQK_ACCESS_TOKEN!,
-  baseUrl: process.env.PLANQK_API_BASE_URL || "https://platform.planqk.de/qc-catalog",
+  baseUrl: process.env.PLANQK_API_BASE_URL!,
+  apiKey: process.env.PLANQK_PERSONAL_ACCESS_TOKEN!,
   organizationId: process.env.PLANQK_ORGANIZATION_ID
 });
 
@@ -59,8 +59,8 @@ async function main() {
   console.time("Add File");
   console.log("\nAdding a file to the Data Pool...");
   const addedFile = await client.dataPools.addDataPoolFile(dataPoolId, {
-    file: fs.createReadStream("test-file.txt"),
-    filename: "my-test-file.txt",
+    file: fs.createReadStream("../test-file.txt"),
+    filename: "test-file.txt",
   });
   const fileId = addedFile.id!;
   console.log(`Added File with ID: ${addedFile.id}, Name: ${addedFile.name}`);
@@ -98,7 +98,7 @@ async function main() {
   console.time("Download File");
   console.log("\nDownloading the file from the Data Pool...");
   const response = await client.dataPools.getDataPoolFile(dataPoolId, fileId);
-  const dest = fs.createWriteStream("test-file.txt");
+  const dest = fs.createWriteStream("../downloaded-test-file.txt");
   Readable.fromWeb(response.stream() as any).pipe(dest);
   await new Promise<void>((resolve) => dest.on("finish", () => resolve())); // Wait for download to complete
   console.log("File downloaded to downloaded-test-file.txt.");
@@ -137,4 +137,4 @@ async function main() {
   console.log("\n--- All documented calls tested ---");
 }
 
-main().catch(console.error);
+main().catch(console.error);

package/apps/ts-test-app/package-lock.json

@@ -8,11 +8,11 @@
       "name": "ts-test-app",
       "version": "1.0.0",
       "dependencies": {
-        "@planqk/planqk-api-sdk": "^1.2.0",
-        "@types/node": "^20.14.10"
+        "@planqk/planqk-api-sdk": "^1"
       },
       "devDependencies": {
-        "typescript": "^5.8.3"
+        "@types/node": "^22",
+        "typescript": "^5"
       }
     },
     "node_modules/@planqk/planqk-api-sdk": {
@@ -32,9 +32,10 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.19.9",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.9.tgz",
-      "integrity": "sha512-cuVNgarYWZqxRJDQHEB58GEONhOK79QVR/qYx4S7kcUObQvUwvFnYxJuuHUKm2aieN9X3yZB4LZsuYNU1Qphsw==",
+      "version": "22.17.0",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-22.17.0.tgz",
+      "integrity": "sha512-bbAKTCqX5aNVryi7qXVMi+OkB3w/OyblodicMbvE38blyAz7GxXf6XYhklokijuPwwVg9sDLKRxt0ZHXQwZVfQ==",
+      "dev": true,
       "license": "MIT",
       "dependencies": {
         "undici-types": "~6.21.0"
@@ -669,6 +670,7 @@
       "version": "6.21.0",
       "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz",
       "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
+      "dev": true,
       "license": "MIT"
     },
     "node_modules/url-join": {

package/apps/ts-test-app/package.json

@@ -3,17 +3,13 @@
   "version": "1.0.0",
   "main": "index.ts",
   "scripts": {
-    "start": "npx tsc && node dist/index.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "npx tsc && node dist/index.js"
   },
-  "keywords": [],
-  "author": "",
-  "description": "",
   "dependencies": {
-    "@planqk/planqk-api-sdk": "^1.2.0",
-    "@types/node": "^20.14.10"
+    "@planqk/planqk-api-sdk": "^1"
   },
   "devDependencies": {
-    "typescript": "^5.8.3"
+    "typescript": "^5",
+    "@types/node": "^22"
   }
-}
+}

package/notebooks/python-sdk.ipynb

@@ -55,6 +55,7 @@
     "\n",
     "# Create a new data pool\n",
     "data_pool = client.data_pools.create_data_pool(name=\"Example Data Pool\")\n",
+    "data_pool = client.api.data_pools.get_data_pool(id=data_pool.id)\n",
     "\n",
     "# Add a file to the data pool\n",
     "file = client.data_pools.add_data_pool_file(\n",
@@ -210,7 +211,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-api-sdk",
-  "version": "1.3.0",
+  "version": "1.3.4",
   "description": "SDK to interact with the official PLANQK API.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/api/_version.py

@@ -1 +1 @@
-__version__ = "1.3.0"
+__version__ = "1.3.4"

package/planqk/api/client.py

@@ -1,6 +1,8 @@
 import os
 from typing import Optional
 
+from deprecated import deprecated
+
 from planqk.api.credentials import DefaultCredentialsProvider
 from planqk.api.sdk import PlanqkApi
 from planqk.api.sdk.data_pools.client import DataPoolsClient
@@ -13,8 +15,9 @@ class PlanqkApiClient:
         base_url = os.environ.get(_PLANQK_API_BASE_URL_NAME, "https://platform.planqk.de/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)
+        self.api = PlanqkApi(base_url=base_url, api_key=credentials_provider.get_access_token(), organization_id=organization_id)
 
     @property
+    @deprecated(version="1.3.0", reason="Use `api.data_pools` instead.")
     def data_pools(self) -> DataPoolsClient:
-        return self._api.data_pools
+        return self.api.data_pools

package/planqk/api/sdk/__init__.py

@@ -2,34 +2,14 @@
 
 # isort: skip_file
 
-from .types import (
-    AccessToken,
-    DataPoolDto,
-    DataPoolDtoCurrentUserPermission,
-    DataPoolFileDto,
-    OauthScope,
-    OrganizationMembership,
-    OrganizationMembershipAccountType,
-    OrganizationMembershipRole,
-    PersonalAccessTokenPrincipal,
-    PersonalAccessTokenPrincipalAccountType,
-    ServiceExecution,
-    ServiceExecutionStatus,
-    ServiceExecutionTokenPrincipal,
-    UserContext,
-    UserContextAccountType,
-    UserContextContextType,
-)
+from .types import DataPoolDto, DataPoolDtoCurrentUserPermission, DataPoolFileDto, OauthScope
 from .errors import BadRequestError, ForbiddenError, InternalServerError, NotFoundError, UnauthorizedError
-from . import authentication, data_pools
-from .authentication import AuthorizeResponse
+from . import data_pools
 from .client import AsyncPlanqkApi, PlanqkApi
 from .environment import PlanqkApiEnvironment
 
 __all__ = [
-    "AccessToken",
     "AsyncPlanqkApi",
-    "AuthorizeResponse",
     "BadRequestError",
     "DataPoolDto",
     "DataPoolDtoCurrentUserPermission",
@@ -38,20 +18,8 @@ __all__ = [
     "InternalServerError",
     "NotFoundError",
     "OauthScope",
-    "OrganizationMembership",
-    "OrganizationMembershipAccountType",
-    "OrganizationMembershipRole",
-    "PersonalAccessTokenPrincipal",
-    "PersonalAccessTokenPrincipalAccountType",
     "PlanqkApi",
     "PlanqkApiEnvironment",
-    "ServiceExecution",
-    "ServiceExecutionStatus",
-    "ServiceExecutionTokenPrincipal",
     "UnauthorizedError",
-    "UserContext",
-    "UserContextAccountType",
-    "UserContextContextType",
-    "authentication",
     "data_pools",
 ]

package/planqk/api/sdk/client.py

@@ -3,7 +3,6 @@
 import typing
 
 import httpx
-from .authentication.client import AsyncAuthenticationClient, AuthenticationClient
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .data_pools.client import AsyncDataPoolsClient, DataPoolsClient
 from .environment import PlanqkApiEnvironment
@@ -79,7 +78,6 @@ class PlanqkApi:
             timeout=_defaulted_timeout,
         )
         self.data_pools = DataPoolsClient(client_wrapper=self._client_wrapper)
-        self.authentication = AuthenticationClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncPlanqkApi:
@@ -152,7 +150,6 @@ class AsyncPlanqkApi:
             timeout=_defaulted_timeout,
         )
         self.data_pools = AsyncDataPoolsClient(client_wrapper=self._client_wrapper)
-        self.authentication = AsyncAuthenticationClient(client_wrapper=self._client_wrapper)
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: PlanqkApiEnvironment) -> str:

package/planqk/api/sdk/types/__init__.py

@@ -2,38 +2,9 @@
 
 # isort: skip_file
 
-from .access_token import AccessToken
 from .data_pool_dto import DataPoolDto
 from .data_pool_dto_current_user_permission import DataPoolDtoCurrentUserPermission
 from .data_pool_file_dto import DataPoolFileDto
 from .oauth_scope import OauthScope
-from .organization_membership import OrganizationMembership
-from .organization_membership_account_type import OrganizationMembershipAccountType
-from .organization_membership_role import OrganizationMembershipRole
-from .personal_access_token_principal import PersonalAccessTokenPrincipal
-from .personal_access_token_principal_account_type import PersonalAccessTokenPrincipalAccountType
-from .service_execution import ServiceExecution
-from .service_execution_status import ServiceExecutionStatus
-from .service_execution_token_principal import ServiceExecutionTokenPrincipal
-from .user_context import UserContext
-from .user_context_account_type import UserContextAccountType
-from .user_context_context_type import UserContextContextType
 
-__all__ = [
-    "AccessToken",
-    "DataPoolDto",
-    "DataPoolDtoCurrentUserPermission",
-    "DataPoolFileDto",
-    "OauthScope",
-    "OrganizationMembership",
-    "OrganizationMembershipAccountType",
-    "OrganizationMembershipRole",
-    "PersonalAccessTokenPrincipal",
-    "PersonalAccessTokenPrincipalAccountType",
-    "ServiceExecution",
-    "ServiceExecutionStatus",
-    "ServiceExecutionTokenPrincipal",
-    "UserContext",
-    "UserContextAccountType",
-    "UserContextContextType",
-]
+__all__ = ["DataPoolDto", "DataPoolDtoCurrentUserPermission", "DataPoolFileDto", "OauthScope"]

package/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.3.0"
+version = "1.3.4"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
 ]
 maintainers = [
     { name = "Michael Wurster", email = "michael.wurster@kipu-quantum.com" },
+    { name = "Lukas Harzenetter", email = "lukas.harzenetter@kipu-quantum.com" },
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -18,6 +19,7 @@ license = { file = "LICENSE" }
 requires-python = ">=3.9"
 dependencies = [
     "authlib>=1.5.1",
+    "deprecated>=1.2.18",
     "httpx>=0.28.1",
     "pydantic>=2.5.0,<2.10",
 ]