qi-compute-api-client 0.38.0__tar.gz → 0.38.2__tar.gz

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.38.0
+Version: 0.38.2
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Home-page: https://github.com/QuTech-Delft/compute-api-client
 License: Apache-2.0
@@ -113,6 +113,7 @@ Class | Method | HTTP request | Description
 *BatchJobsApi* | [**pop_batch_job_batch_jobs_pop_patch**](compute_api_client/docs/BatchJobsApi.md#pop_batch_job_batch_jobs_pop_patch) | **PATCH** /batch_jobs/pop | Take batch job
 *BatchJobsApi* | [**read_batch_jobs_batch_jobs_get**](compute_api_client/docs/BatchJobsApi.md#read_batch_jobs_batch_jobs_get) | **GET** /batch_jobs | List batch jobs
 *BatchJobsApi* | [**unpop_batch_job_batch_jobs_unpop_patch**](compute_api_client/docs/BatchJobsApi.md#unpop_batch_job_batch_jobs_unpop_patch) | **PATCH** /batch_jobs/unpop | Take batch job
+*CommitsApi* | [**compile_commit_commits_id_compile_post**](compute_api_client/docs/CommitsApi.md#compile_commit_commits_id_compile_post) | **POST** /commits/{id}/compile | Compile file in a commit
 *CommitsApi* | [**create_commit_commits_post**](compute_api_client/docs/CommitsApi.md#create_commit_commits_post) | **POST** /commits | Create commit
 *CommitsApi* | [**delete_commit_commits_id_delete**](compute_api_client/docs/CommitsApi.md#delete_commit_commits_id_delete) | **DELETE** /commits/{id} | Destroy commit
 *CommitsApi* | [**read_commit_commits_id_get**](compute_api_client/docs/CommitsApi.md#read_commit_commits_id_get) | **GET** /commits/{id} | Get commit by ID
@@ -184,6 +185,7 @@ Class | Method | HTTP request | Description
  - [BatchJobStatus](compute_api_client/docs/BatchJobStatus.md)
  - [Commit](compute_api_client/docs/Commit.md)
  - [CommitIn](compute_api_client/docs/CommitIn.md)
+ - [CompilePayload](compute_api_client/docs/CompilePayload.md)
  - [CompileStage](compute_api_client/docs/CompileStage.md)
  - [Domain](compute_api_client/docs/Domain.md)
  - [File](compute_api_client/docs/File.md)
@@ -248,7 +250,7 @@ Authentication schemes defined for the API:
 
 - **Type**: OAuth
 - **Flow**: accessCode
-- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_development/protocol/openid-connect/auth
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
 - **Scopes**: N/A
 
 <a id="backend"></a>

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/README.md

@@ -89,6 +89,7 @@ Class | Method | HTTP request | Description
 *BatchJobsApi* | [**pop_batch_job_batch_jobs_pop_patch**](compute_api_client/docs/BatchJobsApi.md#pop_batch_job_batch_jobs_pop_patch) | **PATCH** /batch_jobs/pop | Take batch job
 *BatchJobsApi* | [**read_batch_jobs_batch_jobs_get**](compute_api_client/docs/BatchJobsApi.md#read_batch_jobs_batch_jobs_get) | **GET** /batch_jobs | List batch jobs
 *BatchJobsApi* | [**unpop_batch_job_batch_jobs_unpop_patch**](compute_api_client/docs/BatchJobsApi.md#unpop_batch_job_batch_jobs_unpop_patch) | **PATCH** /batch_jobs/unpop | Take batch job
+*CommitsApi* | [**compile_commit_commits_id_compile_post**](compute_api_client/docs/CommitsApi.md#compile_commit_commits_id_compile_post) | **POST** /commits/{id}/compile | Compile file in a commit
 *CommitsApi* | [**create_commit_commits_post**](compute_api_client/docs/CommitsApi.md#create_commit_commits_post) | **POST** /commits | Create commit
 *CommitsApi* | [**delete_commit_commits_id_delete**](compute_api_client/docs/CommitsApi.md#delete_commit_commits_id_delete) | **DELETE** /commits/{id} | Destroy commit
 *CommitsApi* | [**read_commit_commits_id_get**](compute_api_client/docs/CommitsApi.md#read_commit_commits_id_get) | **GET** /commits/{id} | Get commit by ID
@@ -160,6 +161,7 @@ Class | Method | HTTP request | Description
  - [BatchJobStatus](compute_api_client/docs/BatchJobStatus.md)
  - [Commit](compute_api_client/docs/Commit.md)
  - [CommitIn](compute_api_client/docs/CommitIn.md)
+ - [CompilePayload](compute_api_client/docs/CompilePayload.md)
  - [CompileStage](compute_api_client/docs/CompileStage.md)
  - [Domain](compute_api_client/docs/Domain.md)
  - [File](compute_api_client/docs/File.md)
@@ -224,7 +226,7 @@ Authentication schemes defined for the API:
 
 - **Type**: OAuth
 - **Flow**: accessCode
-- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_development/protocol/openid-connect/auth
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
 - **Scopes**: N/A
 
 <a id="backend"></a>

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/compute_api_client/__init__.py

@@ -63,6 +63,7 @@ from compute_api_client.models.batch_job_in import BatchJobIn
 from compute_api_client.models.batch_job_status import BatchJobStatus
 from compute_api_client.models.commit import Commit
 from compute_api_client.models.commit_in import CommitIn
+from compute_api_client.models.compile_payload import CompilePayload
 from compute_api_client.models.compile_stage import CompileStage
 from compute_api_client.models.domain import Domain
 from compute_api_client.models.file import File

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/compute_api_client/api/commits_api.py

@@ -33,6 +33,7 @@ from typing import Optional
 
 from compute_api_client.models.commit import Commit
 from compute_api_client.models.commit_in import CommitIn
+from compute_api_client.models.compile_payload import CompilePayload
 from compute_api_client.models.page_commit import PageCommit
 
 from compute_api_client.api_client import ApiClient
@@ -53,6 +54,294 @@ class CommitsApi:
         self.api_client = api_client
 
 
+    @validate_call
+    async def compile_commit_commits_id_compile_post(
+        self,
+        id: StrictInt,
+        compile_payload: CompilePayload,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> None:
+        """Compile file in a commit
+
+        Compile file in a commit.
+
+        :param id: (required)
+        :type id: int
+        :param compile_payload: (required)
+        :type compile_payload: CompilePayload
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compile_commit_commits_id_compile_post_serialize(
+            id=id,
+            compile_payload=compile_payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def compile_commit_commits_id_compile_post_with_http_info(
+        self,
+        id: StrictInt,
+        compile_payload: CompilePayload,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[None]:
+        """Compile file in a commit
+
+        Compile file in a commit.
+
+        :param id: (required)
+        :type id: int
+        :param compile_payload: (required)
+        :type compile_payload: CompilePayload
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compile_commit_commits_id_compile_post_serialize(
+            id=id,
+            compile_payload=compile_payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def compile_commit_commits_id_compile_post_without_preload_content(
+        self,
+        id: StrictInt,
+        compile_payload: CompilePayload,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Compile file in a commit
+
+        Compile file in a commit.
+
+        :param id: (required)
+        :type id: int
+        :param compile_payload: (required)
+        :type compile_payload: CompilePayload
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compile_commit_commits_id_compile_post_serialize(
+            id=id,
+            compile_payload=compile_payload,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _compile_commit_commits_id_compile_post_serialize(
+        self,
+        id,
+        compile_payload,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if id is not None:
+            _path_params['id'] = id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if compile_payload is not None:
+            _body_params = compile_payload
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'user_bearer', 
+            'backend'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/commits/{id}/compile',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     async def create_commit_commits_post(
         self,

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/compute_api_client/docs/CommitsApi.md

@@ -4,12 +4,96 @@ All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**compile_commit_commits_id_compile_post**](CommitsApi.md#compile_commit_commits_id_compile_post) | **POST** /commits/{id}/compile | Compile file in a commit
 [**create_commit_commits_post**](CommitsApi.md#create_commit_commits_post) | **POST** /commits | Create commit
 [**delete_commit_commits_id_delete**](CommitsApi.md#delete_commit_commits_id_delete) | **DELETE** /commits/{id} | Destroy commit
 [**read_commit_commits_id_get**](CommitsApi.md#read_commit_commits_id_get) | **GET** /commits/{id} | Get commit by ID
 [**read_commits_commits_get**](CommitsApi.md#read_commits_commits_get) | **GET** /commits | List commits
 
 
+# **compile_commit_commits_id_compile_post**
+> compile_commit_commits_id_compile_post(id, compile_payload)
+
+Compile file in a commit
+
+Compile file in a commit.
+
+### Example
+
+* OAuth Authentication (user_bearer):
+* Api Key Authentication (backend):
+```python
+import time
+import os
+import compute_api_client
+from compute_api_client.models.compile_payload import CompilePayload
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Configure API key authorization: backend
+configuration.api_key['backend'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['backend'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.CommitsApi(api_client)
+    id = 56 # int | 
+    compile_payload = compute_api_client.CompilePayload() # CompilePayload | 
+
+    try:
+        # Compile file in a commit
+        await api_instance.compile_commit_commits_id_compile_post(id, compile_payload)
+    except Exception as e:
+        print("Exception when calling CommitsApi->compile_commit_commits_id_compile_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**|  | 
+ **compile_payload** | [**CompilePayload**](CompilePayload.md)|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[user_bearer](../README.md#user_bearer), [backend](../README.md#backend)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Compiled |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **create_commit_commits_post**
 > Commit create_commit_commits_post(commit_in)
 

qi_compute_api_client-0.38.2/compute_api_client/docs/CompilePayload.md

@@ -0,0 +1,29 @@
+# CompilePayload
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**compile_stage** | [**CompileStage**](CompileStage.md) |  | 
+**backend_type_id** | **int** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.compile_payload import CompilePayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CompilePayload from a JSON string
+compile_payload_instance = CompilePayload.from_json(json)
+# print the JSON string representation of the object
+print CompilePayload.to_json()
+
+# convert the object into a dict
+compile_payload_dict = compile_payload_instance.to_dict()
+# create an instance of CompilePayload from a dict
+compile_payload_form_dict = compile_payload.from_dict(compile_payload_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/compute_api_client/models/__init__.py

@@ -28,6 +28,7 @@ from compute_api_client.models.batch_job_in import BatchJobIn
 from compute_api_client.models.batch_job_status import BatchJobStatus
 from compute_api_client.models.commit import Commit
 from compute_api_client.models.commit_in import CommitIn
+from compute_api_client.models.compile_payload import CompilePayload
 from compute_api_client.models.compile_stage import CompileStage
 from compute_api_client.models.domain import Domain
 from compute_api_client.models.file import File

qi_compute_api_client-0.38.2/compute_api_client/models/compile_payload.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, StrictInt
+from compute_api_client.models.compile_stage import CompileStage
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class CompilePayload(BaseModel):
+    """
+    CompilePayload
+    """ # noqa: E501
+    compile_stage: CompileStage
+    backend_type_id: StrictInt
+    __properties: ClassVar[List[str]] = ["compile_stage", "backend_type_id"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CompilePayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of CompilePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "compile_stage": obj.get("compile_stage"),
+            "backend_type_id": obj.get("backend_type_id")
+        })
+        return _obj
+
+

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/compute_api_client/models/compile_stage.py

@@ -35,9 +35,7 @@ class CompileStage(str, Enum):
     allowed enum values
     """
     NONE = 'none'
-    MAPPED = 'mapped'
-    NATIVE_GATESET = 'native_gateset'
-    SCHEDULED = 'scheduled'
+    DECOMPOSITION = 'decomposition'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{qi_compute_api_client-0.38.0 → qi_compute_api_client-0.38.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qi-compute-api-client"
-version = "0.38.0"
+version = "0.38.2"
 description = "An API client for the Compute Job Manager of Quantum Inspire."
 license = "Apache-2.0"
 authors = ["Quantum Inspire <support@quantum-inspire.eu>"]