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.50

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.50
File Size Uploaded Provenance Actions
qbraid_core-0.6.50.tar.gz 827.2 kB Without provenance Details for qbraid_core-0.6.50.tar.gz

Built distribution (wheel)

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

Total release size: 1.5 MB

Release files / qbraid_core-0.6.50.tar.gz

Download URL qbraid_core-0.6.50.tar.gz
Size 827.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4f606cab9cd26655202186908f5bd0609207db3b2d8845078842951a335e49b0
BLAKE2b-256 checksum
How to use checksums
6705bf00f9a681ca1bb2903a1fff4ff147da371673d5e3f16caeb2f07e96be3a
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.50-py3-none-any.whl

Download URL qbraid_core-0.6.50-py3-none-any.whl
Size 693.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
41d1b6580c8e81e4fd7a48d85a2e1b2a90606acfde38d039b34642458135580e
BLAKE2b-256 checksum
How to use checksums
3c17d2d7db074ff5655397a587f97847c5ad89f4517cbd6b96b75b476b78f104
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.50

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.50 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