@planqk/planqk-api-sdk 1.0.0

package/planqk/api/sdk/environment.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+
+
+class PlanqkApiEnvironment(enum.Enum):
+    DEFAULT = "https://34.90.225.20.nip.io/qc-catalog"

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

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .bad_request_error import BadRequestError
+from .forbidden_error import ForbiddenError
+from .internal_server_error import InternalServerError
+from .not_found_error import NotFoundError
+from .unauthorized_error import UnauthorizedError
+
+__all__ = ["BadRequestError", "ForbiddenError", "InternalServerError", "NotFoundError", "UnauthorizedError"]

package/planqk/api/sdk/errors/bad_request_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class BadRequestError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=400, headers=headers, body=body)

package/planqk/api/sdk/errors/forbidden_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class ForbiddenError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=403, headers=headers, body=body)

package/planqk/api/sdk/errors/internal_server_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class InternalServerError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=500, headers=headers, body=body)

package/planqk/api/sdk/errors/not_found_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class NotFoundError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=404, headers=headers, body=body)

package/planqk/api/sdk/errors/unauthorized_error.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.api_error import ApiError
+
+
+class UnauthorizedError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any], headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=401, headers=headers, body=body)

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

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+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
+
+__all__ = ["DataPoolDto", "DataPoolDtoCurrentUserPermission", "DataPoolFileDto", "OauthScope"]

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

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .data_pool_dto_current_user_permission import DataPoolDtoCurrentUserPermission
+
+
+class DataPoolDto(UniversalBaseModel):
+    current_user_permission: typing_extensions.Annotated[
+        typing.Optional[DataPoolDtoCurrentUserPermission], FieldMetadata(alias="currentUserPermission")
+    ] = pydantic.Field(default=None)
+    """
+    The access permission role for this entity of the current user
+    """
+
+    id: typing.Optional[str] = None
+    name: typing.Optional[str] = None
+    short_description: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="shortDescription")] = None
+    description: typing.Optional[str] = None
+    created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = 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/api/sdk/types/data_pool_dto_current_user_permission.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DataPoolDtoCurrentUserPermission = typing.Union[typing.Literal["VIEWER", "MAINTAINER", "OWNER"], typing.Any]

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

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class DataPoolFileDto(UniversalBaseModel):
+    id: typing.Optional[str] = None
+    data_pool_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="dataPoolId")] = None
+    name: typing.Optional[str] = None
+    full_path: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fullPath")] = None
+    content_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="contentType")] = None
+    content_length: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="contentLength")] = None
+    created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = 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/api/sdk/types/oauth_scope.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+OauthScope = typing.Union[typing.Literal["profile"], typing.Any]

package/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "planqk-api-sdk"
+version = "1.0.0"
+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" },
+]
+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-api-sdk"
+Issues = "https://gitlab.com/planqk-foss/planqk-api-sdk/-/issues"
+Changelog = "https://gitlab.com/planqk-foss/planqk-api-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/api/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

@@ -0,0 +1,53 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { mergeHeaders } from "./core/headers.js";
+import { DataPools } from "./api/resources/dataPools/client/Client.js";
+
+export declare namespace PlanqkApiClient {
+    export interface Options {
+        environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+
+    export 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;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+
+export class PlanqkApiClient {
+    protected readonly _options: PlanqkApiClient.Options;
+    protected _dataPools: DataPools | undefined;
+
+    constructor(_options: PlanqkApiClient.Options) {
+        this._options = {
+            ..._options,
+            headers: mergeHeaders(
+                {
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                _options?.headers,
+            ),
+        };
+    }
+
+    public get dataPools(): DataPools {
+        return (this._dataPools ??= new DataPools(this._options));
+    }
+}

package/src/api/errors/BadRequestError.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors/index.js";
+import * as core from "../../core/index.js";
+
+export class BadRequestError extends errors.PlanqkApiError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}

package/src/api/errors/ForbiddenError.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors/index.js";
+import * as core from "../../core/index.js";
+
+export class ForbiddenError extends errors.PlanqkApiError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}

package/src/api/errors/InternalServerError.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors/index.js";
+import * as core from "../../core/index.js";
+
+export class InternalServerError extends errors.PlanqkApiError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}

package/src/api/errors/NotFoundError.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors/index.js";
+import * as core from "../../core/index.js";
+
+export class NotFoundError extends errors.PlanqkApiError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}

package/src/api/errors/UnauthorizedError.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as errors from "../../errors/index.js";
+import * as core from "../../core/index.js";
+
+export class UnauthorizedError extends errors.PlanqkApiError {
+    constructor(body?: any, rawResponse?: core.RawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+    }
+}

package/src/api/errors/index.ts

@@ -0,0 +1,5 @@
+export * from "./UnauthorizedError.js";
+export * from "./ForbiddenError.js";
+export * from "./NotFoundError.js";
+export * from "./InternalServerError.js";
+export * from "./BadRequestError.js";

package/src/api/index.ts

@@ -0,0 +1,3 @@
+export * from "./types/index.js";
+export * from "./errors/index.js";
+export * from "./resources/index.js";