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.
Release files for qbraid-core 0.6.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qbraid_core-0.6.12.tar.gz | 501.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qbraid_core-0.6.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 880.3 kB
Release files / qbraid_core-0.6.12.tar.gz
| Download URL | qbraid_core-0.6.12.tar.gz |
|---|---|
| Size | 501.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da838235952fa739980fc8ee9a205175bc7a4a5355bb9459e7c4290655aa554c
|
|
BLAKE2b-256 checksum How to use checksums |
8f7fd77758211c5de51731d02e050bdde3e1783460c718be28c4e150c50a3ca9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / qbraid_core-0.6.12-py3-none-any.whl
| Download URL | qbraid_core-0.6.12-py3-none-any.whl |
|---|---|
| Size | 378.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b3e7c668860bac629f450fa4ce0c172696d188b0d30ced463b191888681ff9d7
|
|
BLAKE2b-256 checksum How to use checksums |
6ed10e78e4cee711784e0200716025a6f0afeac651e5b3de7540e2a368a8a583
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
