QCS API Client
A client library for accessing the Rigetti QCS API.
Usage
Synchronous Usage
from qcs_api_client.client import build_sync_client
from qcs_api_client.models import ListReservationsResponse
from qcs_api_client.operations.sync import list_reservations
with build_sync_client() as client:
response: ListReservationsResponse = list_reservations(client=client).parsed
Asynchronous Usage
from qcs_api_client.client import build_async_client
from qcs_api_client.models import ListReservationsResponse
from qcs_api_client.operations.asyncio import list_reservations
# Within an event loop:
async with build_async_client() as client:
response: ListReservationsResponse = await list_reservations(client=client).parsed
Configuration
By default, initializing your client with build_sync_client or build_async_client will
load your QCS configuration using the Python bindings to qcs-api-client-common.
You can influence these with the following environment variables:
- A profile name (env:
QCS_PROFILE_NAME). The name of the profile referenced in your settings file. If not provided, this will evaluate this to adefault_profile_nameset in your settings file or the string"default". - A settings file path (env:
QCS_SETTINGS_FILE_PATH). A path to the current user's settings file in TOML format. If not provided, this will evaluate to~/.qcs/settings.toml. - A secrets file path (env:
QCS_SECRETS_FILE_PATH). A path to the current user's secrets file in TOML format. If not provided, this will evaluate to~/.qcs/secrets.toml. The user should have write access to this file, as the client may update the file with refreshed access tokens.
If you need to specify a custom profile name, you can initialize your client accordingly:
from qcs_api_client_common.configuration import ClientConfiguration
from qcs_api_client.client import build_sync_client
from qcs_api_client.models import ListReservationsResponse
from qcs_api_client.operations.sync import list_reservations
configuration = ClientConfiguration.load_profile(profile_name='custom')
with build_sync_client(configuration=configuration) as client:
response: ListReservationsResponse = list_reservations(client=client).parsed
Development
The source code for this repository is synchronized from another source. No commits made directly to GitHub will be retained.
Release files for qcs_api_client 0.27.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qcs_api_client-0.27.8.tar.gz | 54.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qcs_api_client-0.27.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 229.3 kB
Release files / qcs_api_client-0.27.8.tar.gz
| Download URL | qcs_api_client-0.27.8.tar.gz |
|---|---|
| Size | 54.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ae443aebe7f7342cd841c6b5fb50882d5fd852d8f77ddae070d43b1199a7ff9
|
|
BLAKE2b-256 checksum How to use checksums |
8fc149f59a956d3c214f66dbc5c98baaec3c006c7241985af36cdb7560c44f21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.2 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Release files / qcs_api_client-0.27.8-py3-none-any.whl
| Download URL | qcs_api_client-0.27.8-py3-none-any.whl |
|---|---|
| Size | 174.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c9a195ee7758c0b69e7500df17930480ff4b40dd8b337c1da3033c393c7fe693
|
|
BLAKE2b-256 checksum How to use checksums |
2c4eae0112ac3413f75d9eef50eb3e6ce369373ab1109af0e46ee801a6016853
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.2 CPython/3.12.3 Linux/6.17.0-1022-azure
|