qi-compute-api-client 0.27.0

An API client for the Compute Job Manager of Quantum Inspire.

compute-api-client

Sorting and Pagination of list endpoints The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list. - latest - Type: Boolean. - Description: Get the most recently created object. Defaults to False. - sort_by - Type: String: - Description: The field / column name to sort on. To reverse sort provide the field with a "-" sign. E.g. "created_on" for ascending order while "-created_on" in descending order. Defaults to "id". - page_number - Type: Positive Integer - Description: The page number for pagination. Defaults to 1. - items_per_page - Type: Positive Integer. - Description: The number of items per page for pagination. Defaults to 50.

The compute_api_client package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 1.25.3
• python-dateutil
• aiohttp
• pydantic

Getting Started

In your own code, to use this library to connect and interact with compute-api-client, you can run the following:

import time
import compute_api_client
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: user
configuration.api_key['user'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['user'] = '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.AlgorithmsApi(api_client)
    algorithm_in = compute_api_client.AlgorithmIn() # AlgorithmIn | 

    try:
        # Create algorithm
        api_response = await api_instance.create_algorithm_algorithms_post(algorithm_in)
        print("The response of AlgorithmsApi->create_algorithm_algorithms_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlgorithmsApi->create_algorithm_algorithms_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AlgorithmsApi	create_algorithm_algorithms_post	POST /algorithms	Create algorithm
AlgorithmsApi	delete_algorithm_algorithms_id_delete	DELETE /algorithms/{id}	Destroy algorithm
AlgorithmsApi	read_algorithm_algorithms_id_get	GET /algorithms/{id}	Retrieve algorithm
AlgorithmsApi	read_algorithms_algorithms_get	GET /algorithms	List algorithms
AlgorithmsApi	update_algorithm_algorithms_id_put	PUT /algorithms/{id}	Update algorithm
BackendApi	create_backend_backends_post	POST /backends	Create backend
BackendApi	read_backend_backends_id_get	GET /backends/{id}	Retrieve backend
BackendApi	read_backend_self_backends_me_get	GET /backends/me	Retrieve backend
BackendApi	read_backends_backends_get	GET /backends	List backends
BackendApi	update_backend_self_backends_me_patch	PATCH /backends/me	Update backend
BackendTypesApi	read_backend_type_backend_types_id_get	GET /backend_types/{id}	Retrieve backend type
BackendTypesApi	read_backend_types_backend_types_get	GET /backend_types/	List backend types
BatchJobsApi	create_batch_job_batch_jobs_post	POST /batch_jobs	Create batch job
BatchJobsApi	enqueue_batch_job_batch_jobs_id_enqueue_patch	PATCH /batch_jobs/{id}/enqueue	Enqueue batch job for execution
BatchJobsApi	finish_batch_job_batch_jobs_id_finish_patch	PATCH /batch_jobs/{id}/finish	Finish batch job
BatchJobsApi	peek_batch_job_batch_jobs_peek_patch	PATCH /batch_jobs/peek	Peek batch job
BatchJobsApi	pop_batch_job_batch_jobs_pop_patch	PATCH /batch_jobs/pop	Take batch job
BatchJobsApi	read_batch_jobs_batch_jobs_get	GET /batch_jobs	List batch jobs
BatchJobsApi	unpop_batch_job_batch_jobs_unpop_patch	PATCH /batch_jobs/unpop	Take batch job
CommitsApi	create_commit_commits_post	POST /commits	Create commit
CommitsApi	delete_commit_commits_id_delete	DELETE /commits/{id}	Destroy commit
CommitsApi	read_commit_commits_id_get	GET /commits/{id}	Get commit by ID
CommitsApi	read_commits_commits_get	GET /commits	List commits
FilesApi	create_file_files_post	POST /files	Create file
FilesApi	delete_file_files_id_delete	DELETE /files/{id}	Destroy file
FilesApi	read_file_files_id_get	GET /files/{id}	Retrieve file
FilesApi	read_files_files_get	GET /files	List files
FinalResultsApi	create_final_result_final_results_post	POST /final_results	Create final result
FinalResultsApi	read_final_result_by_job_id_final_results_job_job_id_get	GET /final_results/job/{job_id}	Retrieve final result by job ID
FinalResultsApi	read_final_result_final_results_id_get	GET /final_results/{id}	Retrieve final result
JobsApi	create_job_jobs_post	POST /jobs	Create job
JobsApi	delete_job_jobs_id_delete	DELETE /jobs/{id}	Destroy job
JobsApi	read_job_jobs_id_get	GET /jobs/{id}	Retrieve job
JobsApi	read_jobs_jobs_get	GET /jobs	List jobs
JobsApi	update_job_status_jobs_id_patch	PATCH /jobs/{id}	Update Job Status
LanguagesApi	read_language_languages_id_get	GET /languages/{id}	Retrieve language
LanguagesApi	read_languages_languages_get	GET /languages	List languages
MembersApi	create_member_members_post	POST /members	Create member
MembersApi	delete_member_members_id_delete	DELETE /members/{id}	Destroy member
MembersApi	read_member_members_id_get	GET /members/{id}	Retrieve member
MembersApi	read_members_members_get	GET /members	List members
MetadataApi	create_metadata_self_metadata_post	POST /metadata	Create metadata
MetadataApi	read_metadata_by_backend_id_metadata_backend_backend_id_get	GET /metadata/backend/{backend_id}	Retrieve metadata by backend ID
MetadataApi	read_metadata_metadata_id_get	GET /metadata/{id}	Get metadata by ID
PermissionsApi	read_permission_group_permission_groups_id_get	GET /permission_groups/{id}	Retrieve permission groups
PermissionsApi	read_permission_groups_permission_groups_get	GET /permission_groups/	List permission groups
PermissionsApi	read_permission_permissions_id_get	GET /permissions/{id}	Retrieve permissions
PermissionsApi	read_permissions_permissions_get	GET /permissions/	List permissions
ProjectsApi	create_project_projects_post	POST /projects	Create project
ProjectsApi	delete_project_projects_id_delete	DELETE /projects/{id}	Destroy project
ProjectsApi	partial_update_project_projects_id_patch	PATCH /projects/{id}	Partially update project
ProjectsApi	read_project_projects_id_get	GET /projects/{id}	Retrieve project
ProjectsApi	read_projects_projects_get	GET /projects	List projects
ProjectsApi	update_project_projects_id_put	PUT /projects/{id}	Update project
ReservationsApi	create_reservation_reservations_post	POST /reservations	Create reservation
ReservationsApi	read_reservation_reservations_id_get	GET /reservations/{id}	Retrieve reservation
ReservationsApi	read_reservations_reservations_get	GET /reservations	List reservations
ReservationsApi	terminate_reservation_reservations_id_terminate_patch	PATCH /reservations/{id}/terminate	Terminate reservation
ResultsApi	create_result_results_post	POST /results	Create result
ResultsApi	delete_results_by_job_id_results_job_job_id_delete	DELETE /results/job/{job_id}	Delete results by job ID
ResultsApi	read_result_results_id_get	GET /results/{id}	Retrieve result
ResultsApi	read_results_by_job_id_results_job_job_id_get	GET /results/job/{job_id}	Retrieve results by job ID
TeamsApi	read_team_teams_id_get	GET /teams/{id}	Retrieve teams
TeamsApi	read_teams_teams_get	GET /teams/	List teams
TransactionsApi	read_transaction_transactions_id_get	GET /transactions/{id}	Retrieve transactions
TransactionsApi	read_transactions_transactions_get	GET /transactions/	List transactions
UsersApi	create_user_users_post	POST /users	Create user
UsersApi	delete_user_users_id_delete	DELETE /users/{id}	Destroy user
UsersApi	read_user_users_id_get	GET /users/{id}	Retrieve user
UsersApi	read_users_users_get	GET /users	List users

Documentation For Models

• Algorithm
• AlgorithmIn
• AlgorithmType
• Backend
• BackendIn
• BackendPatch
• BackendStatus
• BackendType
• BackendWithAuthentication
• BatchJob
• BatchJobIn
• BatchJobStatus
• Commit
• CommitIn
• CompileStage
• Domain
• File
• FileIn
• FinalResult
• FinalResultIn
• HTTPNotFoundError
• HTTPValidationError
• Job
• JobIn
• JobPatch
• JobStatus
• Language
• LocationInner
• Member
• MemberIn
• Metadata
• MetadataIn
• Permission
• PermissionGroup
• Project
• ProjectIn
• ProjectPatch
• Reservation
• ReservationIn
• Result
• ResultIn
• Role
• ShareType
• Team
• Transaction
• User
• UserIn
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

user

• Type: API key
• API key parameter name: X-userid
• Location: HTTP header

user_bearer

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
• Scopes: N/A

backend

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author