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.loadwill evaluate this to adefault_profile_nameset 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.loadwill 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.loadwill 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qcs-api-client-0.21.1.tar.gz.
File metadata
- Download URL: qcs-api-client-0.21.1.tar.gz
- Upload date:
- Size: 52.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.14 CPython/3.8.10 Linux/5.15.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ff078b56ba74ac0ca7323a643517192ff37c29a1770721cc074779d39148660
|
|
| MD5 |
e300cfb98c1456f3b5768d74da50e890
|
|
| BLAKE2b-256 |
2692c4d0a7b27f8a221eb2cb2e0f8f0fe61c15c81c6154063bac7c6f7efd6473
|
File details
Details for the file qcs_api_client-0.21.1-py3-none-any.whl.
File metadata
- Download URL: qcs_api_client-0.21.1-py3-none-any.whl
- Upload date:
- Size: 147.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.1.14 CPython/3.8.10 Linux/5.15.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d980641fe045740bab4d819086cc7ed288d5975d87a520eafcda46e62eb159d
|
|
| MD5 |
6f14d33fb94a58189f49e69b8358a9c7
|
|
| BLAKE2b-256 |
795a9f8bfe56f2f5923d4957b9b4b8d2f538c4ab25a4f0b1b95cd3b21db16fd8
|
