qi-compute-api-client 0.7.0

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

compute-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.PythonLegacyClientCodegen

Requirements.

Python 2.7 and 3.4+

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
• six >= 1.10
• python-dateutil
• aiohttp

Getting Started

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

from __future__ import print_function

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.

# Configure API key authorization: user
configuration.api_key['user'] = 'YOUR_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)
        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
BatchRunsApi	create_batch_run_batch_runs_post	POST /batch_runs	Create batch run
BatchRunsApi	enqueue_batch_run_batch_runs_id_enqueue_patch	PATCH /batch_runs/{id}/enqueue	Enqueue batch run for execution
BatchRunsApi	finish_batch_run_batch_runs_id_finish_patch	PATCH /batch_runs/{id}/finish	Finish batch run
BatchRunsApi	peek_batch_run_batch_runs_peek_patch	PATCH /batch_runs/peek	Peek batch run
BatchRunsApi	pop_batch_run_batch_runs_pop_patch	PATCH /batch_runs/pop	Take batch run
BatchRunsApi	read_batch_runs_batch_runs_get	GET /batch_runs	List batch runs
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_run_id_final_results_run_run_id_get	GET /final_results/run/{run_id}	Retrieve final result by run ID
FinalResultsApi	read_final_result_final_results_id_get	GET /final_results/{id}	Retrieve final result
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_metadata_post	POST /metadata	Create metadata
MetadataApi	read_metadata_by_runtime_id_metadata_runtime_runtime_id_get	GET /metadata/runtime/{runtime_id}	Retrieve metadata by runtime 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	read_result_results_id_get	GET /results/{id}	Retrieve result
ResultsApi	read_results_by_run_id_results_run_run_id_get	GET /results/run/{run_id}	Retrieve result
RunsApi	create_run_runs_post	POST /runs	Create run
RunsApi	delete_run_runs_id_delete	DELETE /runs/{id}	Destroy run
RunsApi	read_run_runs_id_get	GET /runs/{id}	Retrieve run
RunsApi	read_runs_runs_get	GET /runs	List runs
RunsApi	start_run_runs_id_start_patch	PATCH /runs/{id}/start	Start run
RuntimeApi	create_runtime_runtimes_post	POST /runtimes	Create runtime
RuntimeApi	read_runtime_runtimes_id_get	GET /runtimes/{id}	Retrieve runtime
RuntimeApi	read_runtimes_runtimes_get	GET /runtimes	List runtimes
RuntimeTypesApi	read_runtime_type_runtime_types_id_get	GET /runtime_types/{id}	Retrieve runtime type
RuntimeTypesApi	read_runtime_types_runtime_types_get	GET /runtime_types/	List runtime types
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
• BatchRun
• BatchRunIn
• BatchRunStatus
• Commit
• CommitIn
• CompileStage
• Domain
• File
• FileIn
• FinalResult
• FinalResultIn
• HTTPNotFoundError
• HTTPValidationError
• Language
• LocationInner
• Member
• MemberIn
• Metadata
• MetadataIn
• Permission
• PermissionGroup
• Project
• ProjectIn
• ProjectPatch
• Reservation
• ReservationIn
• Result
• ResultIn
• Role
• Run
• RunIn
• RunStatus
• Runtime
• RuntimeStatus
• RuntimeType
• RuntimeWithAuthentication
• ShareType
• Team
• Transaction
• User
• UserIn
• ValidationError

Documentation For Authorization

user

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

runtime

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

Author