qbraid-core
Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the qBraid CLI, the qBraid SDK, and qBraid Lab.
You can find the latest, most up to date, documentation here, including a list of services that are supported.
See also: qbraid-core-js
Getting Started
You can install qbraid-core from PyPI with:
python -m pip install qbraid-core
Local configuration
After installing qbraid-core, you must configure your account credentials:
- Create a qBraid account or log in to your existing account by visiting account.qbraid.com
- Navigate to Account > API Keys in the left-sidebar, and then click "Create API Key". See API Key docs.
- Save your API key from step 2 in local configuration file. On Linux and macOS, this file is located at
~/.qbraid/qbraidrc, where~corresponds to your home ($HOME) directory. On Windows, the equivalent default location is%USERPROFILE%\.qbraid\qbraidrc.
[default]
api-key = YOUR_KEY
url = https://api-v2.qbraid.com/api/v1
Or generate your ~/.qbraid/qbraidrc file via the qbraid-core Python interface:
>>> from qbraid_core import QbraidSessionV1
>>> session = QbraidSessionV1(api_key='API_KEY')
>>> session.save_config()
>>> session.get_available_services()
['agents', 'compute', 'environments', 'projects', 'runtime', 'skills', 'storage']
Other credential configuration methods are available using the qBraid-CLI.
Verify setup
After configuring your qBraid credentials, verify your setup by running the following from a Python interpreter:
>>> import qbraid_core
>>> quantum_runtime_client = qbraid_core.client('runtime')
>>> devices = quantum_runtime_client.list_devices()
>>> for device in devices:
... print(device.qrn, device.status)
Community
- For feature requests and bug reports: Submit an issue
- For discussions and/or specific questions about qBraid services, join our discord community
- For questions that are more suited for a forum, post to Stack Overflow with the
qbraidtag.
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 qbraid_core-0.4.0.tar.gz.
File metadata
- Download URL: qbraid_core-0.4.0.tar.gz
- Upload date:
- Size: 390.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae4a9bc0f07e7811d467c0b47b3aadd3c33f1755f34184a033460a5fe3fae82e
|
|
| MD5 |
895948f2976dfda37f3da83ec25bbd3b
|
|
| BLAKE2b-256 |
066bdcdf296e808e7960cbe1c2fe4e0954953c7dfecf81cbbad0d27beb5f8592
|
File details
Details for the file qbraid_core-0.4.0-py3-none-any.whl.
File metadata
- Download URL: qbraid_core-0.4.0-py3-none-any.whl
- Upload date:
- Size: 268.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9391cb10ec7c83bba2104501eece1c234ec2f2e729b5bbf8d11f6ca97f14e96
|
|
| MD5 |
96e6ec7a94d744866e085e1ec43c82ec
|
|
| BLAKE2b-256 |
67bb5d502aa3da6bea0000f26596883c45e00815c2b58d7c02c57092f6ee8529
|
