A client library for accessing the Rigetti QCS API
Project description
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
use QCSClientConfiguation.load
to load default configuration values. This function accepts:
- A profile name (env:
QCS_PROFILE_NAME
). The name of the profile referenced in your settings file. If not provided,QCSClientConfiguation.load
will evaluate this to adefault_profile_name
set in your settings file or "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,QCSClientConfiguation.load
will evaluate this 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,QCSClientConfiguation.load
will evaluate this to~/.qcs/secrets.toml
. The user should have write access to this file, as the client will attempt to update the file with refreshed access tokens as necessary.
If you need to specify a custom profile name or path you can initialize your client accordingly:
from qcs_api_client.client import build_sync_client, QCSClientConfiguration
from qcs_api_client.models import ListReservationsResponse
from qcs_api_client.operations.sync import list_reservations
configuration = QCSClientConfiguration.load(
profile_name='custom',
secrets_file_path='./path/to/custom/secrets.toml',
settings_file_path='./path/to/custom/settings.toml',
)
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
qcs-api-client-0.15.0.tar.gz
(36.8 kB
view hashes)
Built Distribution
Close
Hashes for qcs_api_client-0.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f77de70104407359dbb0cf256aa9b9d9b032878e3fa47c1e7ea9c3787ed1730 |
|
MD5 | 039039de9afef8c57684c85d9914d0be |
|
BLAKE2b-256 | 67e5c87eac8b126cfb9be6e7600b0b71d9d0eb93d2fdf2e1741861bf986e8d01 |