@planqk/planqk-service-sdk 2.11.0 → 2.12.0

package/.env.template

@@ -1,4 +1,4 @@
 TOKEN_ENDPOINT=https://gateway.hub.kipu-quantum.com/token
 SERVICE_ENDPOINT=https://gateway.hub.kipu-quantum.com/your-organization/your-service/1.0.0
-CONSUMER_KEY=your-consumer-key
-CONSUMER_SECRET=your-consumer-secret
+ACCESS_KEY_ID=your-access-key-id
+SECRET_ACCESS_KEY=your-secret-access-key

package/README-node.md

@@ -12,11 +12,11 @@ npm install @planqk/planqk-service-sdk
 
 ```typescript
 const serviceEndpoint = "..."
-const consumerKey = "..."
-const consumerSecret = "..."
+const accessKeyId = "..."
+const secretAccessKey = "..."
 
 // Create a new PlanqkServiceClient instance
-const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
+const client = new PlanqkServiceClient(serviceEndpoint, accessKeyId, secretAccessKey)
 
 // List all service executions
 const serviceExecutions = await client.api().getServiceExecutions()

package/README-python.md

@@ -14,12 +14,12 @@ pip install --upgrade planqk-service-sdk
 import os
 from planqk.service.client import PlanqkServiceClient
 
-consumer_key = "..."
-consumer_secret = "..."
 service_endpoint = "..."
+access_key_id = "..."
+secret_access_key = "..."
 
 # Create a new PlanqkServiceClient instance
-client = PlanqkServiceClient(service_endpoint, consumer_key, consumer_secret)
+client = PlanqkServiceClient(service_endpoint, access_key_id, secret_access_key)
 
 # Prepare your input data and parameters
 data = {"values": [2]}

package/README.md

@@ -12,11 +12,11 @@ npm install @planqk/planqk-service-sdk
 
 ```typescript
 const serviceEndpoint = "..."
-const consumerKey = "..."
-const consumerSecret = "..."
+const accessKeyId = "..."
+const secretAccessKey = "..."
 
 // Create a new PlanqkServiceClient instance
-const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
+const client = new PlanqkServiceClient(serviceEndpoint, accessKeyId, secretAccessKey)
 
 // List all service executions
 const serviceExecutions = await client.api().getServiceExecutions()

package/dist/auth.d.ts

@@ -1,10 +1,10 @@
 export declare const DEFAULT_TOKEN_ENDPOINT = "https://gateway.hub.kipu-quantum.com/token";
 export declare class PlanqkServiceAuth {
     private accessToken;
-    private readonly consumerKey;
-    private readonly consumerSecret;
+    private readonly accessKeyId;
+    private readonly secretAccessKey;
     private readonly tokenEndpoint;
-    constructor(consumerKey: string, consumerSecret: string, tokenEndpoint?: string);
+    constructor(accessKeyId: string, secretAccessKey: string, tokenEndpoint?: string);
     getAccessToken(): Promise<string>;
     private fetchAccessToken;
 }

package/dist/auth.js

@@ -5,12 +5,12 @@ const simple_oauth2_1 = require("simple-oauth2");
 exports.DEFAULT_TOKEN_ENDPOINT = 'https://gateway.hub.kipu-quantum.com/token';
 class PlanqkServiceAuth {
     accessToken;
-    consumerKey;
-    consumerSecret;
+    accessKeyId;
+    secretAccessKey;
     tokenEndpoint;
-    constructor(consumerKey, consumerSecret, tokenEndpoint = exports.DEFAULT_TOKEN_ENDPOINT) {
-        this.consumerKey = consumerKey;
-        this.consumerSecret = consumerSecret;
+    constructor(accessKeyId, secretAccessKey, tokenEndpoint = exports.DEFAULT_TOKEN_ENDPOINT) {
+        this.accessKeyId = accessKeyId;
+        this.secretAccessKey = secretAccessKey;
         this.tokenEndpoint = tokenEndpoint;
     }
     async getAccessToken() {
@@ -29,8 +29,8 @@ class PlanqkServiceAuth {
                 tokenPath: '/token',
             },
             client: {
-                id: this.consumerKey,
-                secret: this.consumerSecret,
+                id: this.accessKeyId,
+                secret: this.secretAccessKey,
             },
             options: {
                 authorizationMethod: 'body',

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { ServiceApi } from "./sdk/api/resources/serviceApi/client/Client";
 export declare class PlanqkServiceClient {
     private _api;
-    constructor(serviceEndpoint: string, consumerKey?: string, consumerSecret?: string, tokenEndpoint?: string);
+    constructor(serviceEndpoint: string, accessKeyId?: string, secretAccessKey?: string, tokenEndpoint?: string);
     api(): ServiceApi;
 }

package/dist/client.js

@@ -5,9 +5,9 @@ const auth_1 = require("./auth");
 const sdk_1 = require("./sdk");
 class PlanqkServiceClient {
     _api;
-    constructor(serviceEndpoint, consumerKey, consumerSecret, tokenEndpoint = auth_1.DEFAULT_TOKEN_ENDPOINT) {
-        if (consumerKey && consumerSecret) {
-            const auth = new auth_1.PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint);
+    constructor(serviceEndpoint, accessKeyId, secretAccessKey, tokenEndpoint = auth_1.DEFAULT_TOKEN_ENDPOINT) {
+        if (accessKeyId && secretAccessKey) {
+            const auth = new auth_1.PlanqkServiceAuth(accessKeyId, secretAccessKey, tokenEndpoint);
             this._api = new sdk_1.PlanqkServiceApiClient({
                 environment: () => serviceEndpoint,
                 token: async () => auth.getAccessToken(),

package/notebooks/python-sdk.ipynb

@@ -28,13 +28,11 @@
     "\n",
     "token_endpoint = os.getenv(\"TOKEN_ENDPOINT\", \"https://gateway.hub.kipu-quantum.com/token\")\n",
     "service_endpoint = os.getenv(\"SERVICE_ENDPOINT\", \"https://gateway.hub.kipu-quantum.com/your-organization/your-service/1.0.0\")\n",
-    "consumer_key = os.getenv(\"CONSUMER_KEY\", None)\n",
-    "consumer_secret = os.getenv(\"CONSUMER_SECRET\", None)\n",
+    "access_key_id = os.getenv(\"ACCESS_KEY_ID\", None)\n",
+    "secret_access_key = os.getenv(\"SECRET_ACCESS_KEY\", None)\n",
     "\n",
     "print(f\"Token endpoint: {token_endpoint}\")\n",
-    "print(f\"Service endpoint: {service_endpoint}\")\n",
-    "print(f\"Consumer key: {consumer_key}\")\n",
-    "print(f\"Consumer secret: {consumer_secret}\")"
+    "print(f\"Service endpoint: {service_endpoint}\")"
    ]
   },
   {
@@ -54,7 +52,7 @@
     "\n",
     "# Create a new PlanqkServiceClient instance\n",
     "client = PlanqkServiceClient(\n",
-    "    service_endpoint, consumer_key, consumer_secret, token_endpoint\n",
+    "    service_endpoint, access_key_id, secret_access_key, token_endpoint\n",
     ")"
    ]
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.11.0"
+__version__ = "2.12.0"

package/planqk/service/auth.py

@@ -9,9 +9,9 @@ DEFAULT_TOKEN_ENDPOINT = "https://gateway.hub.kipu-quantum.com/token"
 class PlanqkServiceAuth:
     _logger = logging.getLogger(__name__)
 
-    def __init__(self, consumer_key: str, consumer_secret: str, token_endpoint: str = DEFAULT_TOKEN_ENDPOINT):
-        self._consumer_key = consumer_key
-        self._consumer_secret = consumer_secret
+    def __init__(self, access_key_id: str, secret_access_key: str, token_endpoint: str = DEFAULT_TOKEN_ENDPOINT):
+        self._access_key_id = access_key_id
+        self._secret_access_key = secret_access_key
         self._token_endpoint = token_endpoint
         self._token = None
         self._last_token_fetch = None
@@ -28,7 +28,7 @@ class PlanqkServiceAuth:
 
     def _refresh_token(self):
         self._logger.debug("Creating new token using client credentials flow")
-        with OAuth2Client(self._consumer_key, self._consumer_secret) as client:
+        with OAuth2Client(self._access_key_id, self._secret_access_key) as client:
             token = client.fetch_token(self._token_endpoint, grant_type='client_credentials')
 
         self._token = token

package/planqk/service/client.py

@@ -113,19 +113,19 @@ class PlanqkServiceClient:
     def __init__(
             self,
             service_endpoint: str,
-            consumer_key: typing.Union[str, None],
-            consumer_secret: typing.Union[str, None],
+            access_key_id: typing.Union[str, None],
+            secret_access_key: typing.Union[str, None],
             token_endpoint: str = DEFAULT_TOKEN_ENDPOINT,
     ):
         self._service_endpoint = service_endpoint
-        self._consumer_key = consumer_key
-        self._consumer_secret = consumer_secret
+        self._access_key_id = access_key_id
+        self._secret_access_key = secret_access_key
         self._token_endpoint = token_endpoint
 
-        if (self._consumer_key is not None) or (self._consumer_secret is not None):
+        if (self._access_key_id is not None) or (self._secret_access_key is not None):
             self._auth = PlanqkServiceAuth(
-                consumer_key=self._consumer_key,
-                consumer_secret=self._consumer_secret,
+                access_key_id=self._access_key_id,
+                secret_access_key=self._secret_access_key,
                 token_endpoint=self._token_endpoint,
             )
             self._api = PlanqkServiceApi(base_url=self._service_endpoint, token=self._auth.get_token)

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-service-sdk"
-version = "2.11.0"
+version = "2.12.0"
 description = "SDK to interact with PLANQK Managed Services."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },

package/src/auth.ts

@@ -4,13 +4,13 @@ export const DEFAULT_TOKEN_ENDPOINT = 'https://gateway.hub.kipu-quantum.com/toke
 
 export class PlanqkServiceAuth {
   private accessToken: AccessToken | undefined
-  private readonly consumerKey: string
-  private readonly consumerSecret: string
+  private readonly accessKeyId: string
+  private readonly secretAccessKey: string
   private readonly tokenEndpoint: string
 
-  constructor(consumerKey: string, consumerSecret: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
-    this.consumerKey = consumerKey
-    this.consumerSecret = consumerSecret
+  constructor(accessKeyId: string, secretAccessKey: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
+    this.accessKeyId = accessKeyId
+    this.secretAccessKey = secretAccessKey
     this.tokenEndpoint = tokenEndpoint
   }
 
@@ -33,8 +33,8 @@ export class PlanqkServiceAuth {
         tokenPath: '/token',
       },
       client: {
-        id: this.consumerKey,
-        secret: this.consumerSecret,
+        id: this.accessKeyId,
+        secret: this.secretAccessKey,
       },
       options: {
         authorizationMethod: 'body',

package/src/client.ts

@@ -5,9 +5,9 @@ import {ServiceApi} from "./sdk/api/resources/serviceApi/client/Client";
 export class PlanqkServiceClient {
   private _api: PlanqkServiceApiClient
 
-  constructor(serviceEndpoint: string, consumerKey?: string, consumerSecret?: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
-    if (consumerKey && consumerSecret) {
-      const auth = new PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint)
+  constructor(serviceEndpoint: string, accessKeyId?: string, secretAccessKey?: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
+    if (accessKeyId && secretAccessKey) {
+      const auth = new PlanqkServiceAuth(accessKeyId, secretAccessKey, tokenEndpoint)
       this._api = new PlanqkServiceApiClient({
         environment: () => serviceEndpoint,
         token: async () => auth.getAccessToken(),

package/src/index.test.ts

@@ -6,16 +6,14 @@ import {withDataPoolReference} from "./datapool";
 
 const tokenEndpoint = process.env.TOKEN_ENDPOINT
 const serviceEndpoint = process.env.SERVICE_ENDPOINT
-const consumerKey = process.env.CONSUMER_KEY
-const consumerSecret = process.env.CONSUMER_SECRET
+const accessKeyId = process.env.ACCESS_KEY_ID
+const secretAccessKey = process.env.SECRET_ACCESS_KEY
 
 console.log(`Token endpoint: ${tokenEndpoint}`)
 console.log(`Service endpoint: ${serviceEndpoint}`)
-console.log(`Consumer key: ${consumerKey}`)
-console.log(`Consumer secret: ${consumerSecret}`)
 
 test.skip('integration test: retrieve logs', {timeout: 5 * 60 * 1000}, async () => {
-  const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
+  const client = new PlanqkServiceClient(serviceEndpoint!, accessKeyId, secretAccessKey, tokenEndpoint);
 
   const serviceExecutions = await client.api().getServiceExecutions()
   console.log(serviceExecutions)
@@ -25,7 +23,7 @@ test.skip('integration test: retrieve logs', {timeout: 5 * 60 * 1000}, async ()
 })
 
 test.skip('integration test: coin toss', {timeout: 5 * 60 * 1000}, async () => {
-  const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
+  const client = new PlanqkServiceClient(serviceEndpoint!, accessKeyId, secretAccessKey, tokenEndpoint);
 
   let serviceExecutions = await client.api().getServiceExecutions()
   console.log(serviceExecutions)
@@ -62,7 +60,7 @@ test.skip('integration test: coin toss', {timeout: 5 * 60 * 1000}, async () => {
 })
 
 test.skip('integration test: using data pools', {timeout: 5 * 60 * 1000}, async () => {
-  const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
+  const client = new PlanqkServiceClient(serviceEndpoint!, accessKeyId, secretAccessKey, tokenEndpoint);
 
   const data = {file_to_read: "example.txt"}
   const dataset = withDataPoolReference("89ae42e1-9697-4742-adfb-95bf018104c3")