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.
Metadata
Release files for qbraid-core 0.6.39
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qbraid_core-0.6.39.tar.gz | 680.0 kB | Without provenance | Details for qbraid_core-0.6.39.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qbraid_core-0.6.39-py3-none-any.whl | Python 3 | none | any | Details for qbraid_core-0.6.39-py3-none-any.whl |
Total release size: 1.2 MB
Release files / qbraid_core-0.6.39.tar.gz
| Download URL | qbraid_core-0.6.39.tar.gz |
|---|---|
| Size | 680.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3211e6d8b44e5e5895f7cdf09708c9d400458ab7b5e54828f7396eeb614751b5
|
|
BLAKE2b-256 checksum How to use checksums |
8f26db3429c0ecb85159df53766654918d71f6a96ef319441688c843fa437269
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / qbraid_core-0.6.39-py3-none-any.whl
| Download URL | qbraid_core-0.6.39-py3-none-any.whl |
|---|---|
| Size | 549.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4ef30e7de5a1d2d83b8182fa3cc498763a2232bd041a666d989ac78ac84aa812
|
|
BLAKE2b-256 checksum How to use checksums |
57250d3ed8aef3a0d3ab86665b8283b804e2b7604a9942eaacc77c408d8d225e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for qbraid-core 0.6.39
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.