Skip to main content

qbraid-core

Documentation codecov PyPI version Python verions GitHub

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:

  1. Create a qBraid account or log in to your existing account by visiting account.qbraid.com
  2. Navigate to Account > API Keys in the left-sidebar, and then click "Create API Key". See API Key docs.
  3. 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

Metadata

Release files for qbraid-core 0.6.41

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qbraid-core 0.6.41
File Size Uploaded Provenance Actions
qbraid_core-0.6.41.tar.gz 695.5 kB Without provenance Details for qbraid_core-0.6.41.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qbraid-core 0.6.41
File Interpreter ABI Platform Actions
qbraid_core-0.6.41-py3-none-any.whl Python 3 none any Details for qbraid_core-0.6.41-py3-none-any.whl

Total release size: 1.3 MB

Release files / qbraid_core-0.6.41.tar.gz

Download URL qbraid_core-0.6.41.tar.gz
Size 695.5 kB
Tags Source
SHA-256 checksum
How to use checksums
88a7166ff0dae6878e02bbc3b2e044633ea9a0fb1bf59c3da0e3fe8afdc3fd34
BLAKE2b-256 checksum
How to use checksums
1bbdbc29a8763458a8aac915e4702d2b5933ef0743d82313a8849cbcc2d24e3e
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.41-py3-none-any.whl

Download URL qbraid_core-0.6.41-py3-none-any.whl
Size 563.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af50ceafea1965296976252312bc9012ef86bee5ad57e5d8bd049ae86e94fcfe
BLAKE2b-256 checksum
How to use checksums
81258d59e8adf18482b42a5982dcf7f5b47929b51ef387807cde15dbcbef4941
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.41

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.

Release history Release notifications | RSS feed

This release

0.6.41 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page