@planqk/planqk-service-sdk 1.9.1 → 2.1.1

package/planqk/service/sdk/service_api/types/__init__.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .get_result_response import GetResultResponse
+from .get_result_response_embedded import GetResultResponseEmbedded
+from .get_result_response_links import GetResultResponseLinks
+from .health_check_response import HealthCheckResponse
+
+__all__ = [
+    "GetResultResponse",
+    "GetResultResponseEmbedded",
+    "GetResultResponseLinks",
+    "HealthCheckResponse",
+]

package/planqk/service/sdk/service_api/types/get_result_response.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+import typing
+from .get_result_response_links import GetResultResponseLinks
+from ...core.serialization import FieldMetadata
+from .get_result_response_embedded import GetResultResponseEmbedded
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GetResultResponse(UniversalBaseModel):
+    links: typing_extensions.Annotated[
+        typing.Optional[GetResultResponseLinks], FieldMetadata(alias="_links")
+    ] = None
+    embedded: typing_extensions.Annotated[
+        typing.Optional[GetResultResponseEmbedded], FieldMetadata(alias="_embedded")
+    ] = None
+
+    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/planqk/service/sdk/service_api/types/get_result_response_embedded.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+from ...types.service_execution import ServiceExecution
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GetResultResponseEmbedded(UniversalBaseModel):
+    status: typing.Optional[ServiceExecution] = None
+
+    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/planqk/service/sdk/service_api/types/get_result_response_links.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+from ...types.hal_link import HalLink
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class GetResultResponseLinks(UniversalBaseModel):
+    status: typing.Optional[HalLink] = None
+
+    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/planqk/service/sdk/service_api/types/health_check_response.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class HealthCheckResponse(UniversalBaseModel):
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status of the service
+    """
+
+    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/planqk/service/sdk/types/__init__.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .hal_link import HalLink
+from .input_data import InputData
+from .input_data_ref import InputDataRef
+from .input_params import InputParams
+from .service_execution import ServiceExecution
+from .service_execution_status import ServiceExecutionStatus
+
+__all__ = [
+    "HalLink",
+    "InputData",
+    "InputDataRef",
+    "InputParams",
+    "ServiceExecution",
+    "ServiceExecutionStatus",
+]

package/planqk/service/sdk/types/hal_link.py

@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class HalLink(UniversalBaseModel):
+    href: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The URL of the link
+    """
+
+    templated: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the link is templated (optional)
+    """
+
+    type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The media type of the link (optional)
+    """
+
+    deprecation: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A URL that provides further information about the deprecation of the link (optional)
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the link (optional)
+    """
+
+    profile: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A URL that provides further information about the profile of the link (optional)
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The title of the link (optional)
+    """
+
+    hreflang: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The language of the link's target resource (optional)
+    """
+
+    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/planqk/service/sdk/types/input_data.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+InputData = typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]]

package/planqk/service/sdk/types/input_data_ref.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class InputDataRef(UniversalBaseModel):
+    data_pool_id: typing_extensions.Annotated[str, FieldMetadata(alias="dataPoolId")]
+    data_source_descriptor_id: typing_extensions.Annotated[
+        str, FieldMetadata(alias="dataSourceDescriptorId")
+    ]
+    file_id: typing_extensions.Annotated[str, FieldMetadata(alias="fileId")]
+
+    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/planqk/service/sdk/types/input_params.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+InputParams = typing.Dict[str, typing.Dict[str, typing.Optional[typing.Any]]]

package/planqk/service/sdk/types/service_execution.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from .service_execution_status import ServiceExecutionStatus
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ServiceExecution(UniversalBaseModel):
+    id: typing.Optional[str] = None
+    status: typing.Optional[ServiceExecutionStatus] = None
+    created_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="createdAt")
+    ] = None
+    started_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="startedAt")
+    ] = None
+    ended_at: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="endedAt")
+    ] = None
+
+    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/planqk/service/sdk/types/service_execution_status.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ServiceExecutionStatus = typing.Union[
+    typing.Literal["UNKNOWN", "PENDING", "RUNNING", "SUCCEEDED", "CANCELLED", "FAILED"],
+    typing.Any,
+]

package/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "planqk-service-sdk"
+version = "2.1.1"
+description = "SDK to interact with PLANQK Managed Services."
+authors = [
+    { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
+]
+maintainers = [
+    { name = "Michael Wurster", email = "michael.wurster@kipu-quantum.com" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+readme = "README-python.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+dependencies = [
+    "authlib>=1.5.1",
+    "httpx>=0.28.1",
+    "pydantic>=2.5.0,<2.10",
+]
+
+[dependency-groups]
+dev = [
+    "ipykernel>=6.29.5",
+    "pylint>=3.3.5",
+    "pytest>=8.3.5",
+    "pytest-dotenv>=0.5.2",
+]
+
+[project.urls]
+Homepage = "https://kipu-quantum.com/platform"
+Documentation = "https://docs.planqk.de"
+Repository = "https://gitlab.com/planqk-foss/planqk-service-sdk"
+Issues = "https://gitlab.com/planqk-foss/planqk-service-sdk/-/issues"
+Changelog = "https://gitlab.com/planqk-foss/planqk-service-sdk/-/releases"
+
+[build-system]
+requires = ["setuptools >= 61.0", "wheel", "twine"]
+build-backend = "setuptools.build_meta"
+
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+[tool.setuptools.packages.find]
+include = ["planqk*"]
+
+[tool.pylint.MASTER]
+ignore-paths = '^planqk/service/sdk/.*$'
+max-line-length = 120
+disable = ['missing-module-docstring', 'missing-class-docstring', 'missing-function-docstring']

package/scripts/update-version.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+version=${1:-0.0.0}
+
+sed -i "s/^__version__ = .*$/__version__ = \"${version}\"/g" planqk/service/_version.py
+sed -i "s/^version = .*$/version = \"${version}\"/g" pyproject.toml

package/src/client.ts

@@ -1,16 +1,6 @@
 import {DEFAULT_TOKEN_ENDPOINT, PlanqkServiceAuth} from './auth'
-import {PlanqkServiceApiClient} from './sdk'
-import {
-  GetInterimResultsRequest,
-  GetInterimResultsResponse,
-  GetResultResponse,
-  HealthCheckResponse,
-  Job,
-  JobStatus,
-  NotFoundError,
-  StartExecutionRequest,
-} from './sdk/api'
-import {ServiceApi} from './sdk/api/resources/serviceApi/client/Client'
+import {PlanqkServiceApiClient} from "./sdk";
+import {ServiceApi} from "./sdk/api/resources/serviceApi/client/Client";
 
 export class PlanqkServiceClient {
   private _api: PlanqkServiceApiClient
@@ -30,71 +20,7 @@ export class PlanqkServiceClient {
     }
   }
 
-  public cancelExecution(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<Job> {
-    return this._api.serviceApi.cancelExecution(jobId, requestOptions)
-  }
-
-  public getInterimResults(jobId: string, request: GetInterimResultsRequest = {}, requestOptions?: ServiceApi.RequestOptions): Promise<GetInterimResultsResponse> {
-    return this._api.serviceApi.getInterimResults(jobId, request, requestOptions)
-  }
-
-  public async getResult(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<GetResultResponse> {
-    await this.waitForFinalState(jobId)
-    return this.doGetResultWithRetries(jobId, requestOptions)
-  }
-
-  public getStatus(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<Job> {
-    return this._api.serviceApi.getStatus(jobId, requestOptions)
-  }
-
-  public healthCheck(requestOptions?: ServiceApi.RequestOptions): Promise<HealthCheckResponse> {
-    return this._api.statusApi.healthCheck(requestOptions)
-  }
-
-  public startExecution(request: StartExecutionRequest = {}, requestOptions?: ServiceApi.RequestOptions): Promise<Job> {
-    return this._api.serviceApi.startExecution(request, requestOptions)
-  }
-
-  private async doGetResultWithRetries(jobId: string, requestOptions?: ServiceApi.RequestOptions, retries: number = 5, delay: number = 1000): Promise<GetResultResponse> {
-    try {
-      return await this._api.serviceApi.getResult(jobId, requestOptions)
-    } catch (error) {
-      if (error instanceof NotFoundError) {
-        if (retries === 0) throw error
-        // Wait for the specified delay
-        await new Promise(resolve => {
-          setTimeout(resolve, delay)
-        })
-        // Double the delay, but cap it at 16 seconds
-        const newDelay = Math.min(delay * 2, 16_000)
-        return this.doGetResultWithRetries(jobId, requestOptions, retries - 1, newDelay)
-      }
-
-      throw error
-    }
-  }
-
-  private async doWaitForFinalState(jobId: string, timeout?: number, waitTime: number = 5, startTime: number = Date.now()): Promise<void> {
-    const job = await this.getStatus(jobId)
-    if (this.jobHasFinished(job)) return
-
-    const elapsedTime = Date.now() - startTime
-    if (timeout !== undefined && elapsedTime >= timeout * 1000) {
-      throw new Error(`Timeout while waiting for job '${jobId}'.`)
-    }
-
-    await new Promise(resolve => {
-      setTimeout(resolve, waitTime * 1000)
-    })
-
-    await this.doWaitForFinalState(jobId, timeout, waitTime, startTime)
-  }
-
-  private jobHasFinished(job: Job): boolean {
-    return (job.status === JobStatus.Succeeded || job.status === JobStatus.Failed || job.status === JobStatus.Cancelled)
-  }
-
-  private async waitForFinalState(jobId: string, timeout?: number, wait: number = 5): Promise<void> {
-    await this.doWaitForFinalState(jobId, timeout, wait)
+  public api(): ServiceApi {
+    return this._api.serviceApi
   }
 }

package/src/index.test.ts

@@ -0,0 +1,43 @@
+import process from 'node:process'
+import {test} from 'vitest'
+import 'dotenv/config'
+import {PlanqkServiceClient} from "./client";
+
+test.skip('adds 1 + 2 to equal 3', {timeout: 5 * 60 * 1000}, async () => {
+  const tokenEndpoint = process.env.TOKEN_ENDPOINT
+  const serviceEndpoint = process.env.SERVICE_ENDPOINT
+  const consumerKey = process.env.CONSUMER_KEY
+  const consumerSecret = process.env.CONSUMER_SECRET
+
+  console.log(`Token endpoint: ${tokenEndpoint}`)
+  console.log(`Service endpoint: ${serviceEndpoint}`)
+  console.log(`Consumer key: ${consumerKey}`)
+  console.log(`Consumer secret: ${consumerSecret}`)
+
+  const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
+  await client.api().healthCheck()
+
+  // prepare your input data and parameters
+  const data = {input: {a: 1, b: 2}};
+  const params = {param1: "value1", param2: "value2"};
+
+  // execute the service
+  let serviceExecution = await client.api().execute({data, params})
+  console.log(serviceExecution)
+
+  // retrieve the status of a service execution
+  serviceExecution = await client.api().getStatus(serviceExecution.id!);
+
+  // wait for the service execution to finish
+  const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"];
+  while (!finalStates.includes(serviceExecution.status!)) {
+    serviceExecution = await client.api().getStatus(serviceExecution.id!);
+  }
+  console.log(serviceExecution)
+
+  // retrieve the result
+  await client.api().getResult(serviceExecution.id!)
+
+  // retrieve the logs
+  await client.api().getLogs(serviceExecution.id!)
+})

package/src/sdk/Client.ts

@@ -4,7 +4,6 @@
 
 import * as environments from "./environments";
 import * as core from "./core";
-import { StatusApi } from "./api/resources/statusApi/client/Client";
 import { ServiceApi } from "./api/resources/serviceApi/client/Client";
 
 export declare namespace PlanqkServiceApiClient {
@@ -14,20 +13,18 @@ export declare namespace PlanqkServiceApiClient {
     }
 
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 
 export class PlanqkServiceApiClient {
     constructor(protected readonly _options: PlanqkServiceApiClient.Options) {}
 
-    protected _statusApi: StatusApi | undefined;
-
-    public get statusApi(): StatusApi {
-        return (this._statusApi ??= new StatusApi(this._options));
-    }
-
     protected _serviceApi: ServiceApi | undefined;
 
     public get serviceApi(): ServiceApi {

package/src/sdk/api/errors/BadRequestError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 
 export class BadRequestError extends errors.PlanqkServiceApiError {
     constructor(body?: any) {

package/src/sdk/api/errors/ForbiddenError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 
 export class ForbiddenError extends errors.PlanqkServiceApiError {
     constructor(body?: any) {

package/src/sdk/api/errors/InternalServerError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 
 export class InternalServerError extends errors.PlanqkServiceApiError {
     constructor(body?: any) {

package/src/sdk/api/errors/NotFoundError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 
 export class NotFoundError extends errors.PlanqkServiceApiError {
     constructor(body?: any) {

package/src/sdk/api/errors/UnauthorizedError.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as errors from "../../errors";
+import * as errors from "../../errors/index";
 
 export class UnauthorizedError extends errors.PlanqkServiceApiError {
     constructor(body?: any) {

package/src/sdk/api/resources/index.ts

@@ -1,5 +1,2 @@
-export * as statusApi from "./statusApi";
-export * from "./statusApi/types";
 export * as serviceApi from "./serviceApi";
 export * from "./serviceApi/types";
-export * from "./serviceApi/client/requests";