qbraid-core 0.2.0

Python library with core abstractions for software development in the qBraid ecosystem.

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 the jupyter-environment-manager.

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. Copy your API Key from the left side of your account page:
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

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()
['environments', 'runtime', '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 qbraid tag.

Launch on qBraid

The "Launch on qBraid" button (below) can be added to any public GitHub repository. Clicking on it automaically opens qBraid Lab, and performs a git clone of the project repo into your account's home directory. Copy the code below, and replace YOUR-USERNAME and YOUR-REPOSITORY with your GitHub info.

Use the badge in your project's README.md:

[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git)

Use the badge in your project's README.rst:

.. image:: https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png
    :target: https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
    :width: 150px