# qbraid-core
[](https://sdk.qbraid.com/projects/core/en/latest/)
[](https://codecov.io/gh/qBraid/qbraid-core)
[](https://pypi.org/project/qbraid-core/)
[](https://pypi.org/project/qbraid-core/)
[](https://github.com/qBraid/community/issues)
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](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and the
[jupyter-environment-manager](https://pypi.org/project/jupyter-environment-manager/).
You can find the latest, most up to date, documentation [here](https://sdk.qbraid.com/projects/core/en/latest/), including a list of services that are supported.
## Getting Started
You can install qbraid-core from PyPI with:
```bash
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](https://account.qbraid.com/)
2. Copy your API Key token from the left side of
your [account page](https://account.qbraid.com/):
3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc`, where `~` corresponds to your home (`$HOME`) directory:
```bash
[default]
api-key = YOUR_KEY
url = https://api.qbraid.com/api
```
Or generate your `~/.qbraid/qbraidrc` file via the qbraid-core Python interface:
```python
>>> from qbraid_core import QbraidSession
>>> session = QbraidSession(api_key='API_KEY')
>>> session.save_config()
>>> session.get_available_services()
['environments', 'quantum']
```
Other credential configuration methods can be found [here](https://docs.qbraid.com/cli/api-reference/qbraid_configure).
### Verify setup
After configuring your qBraid credentials, verify your setup by running the following from a Python interpreter:
```python
>>> import qbraid_core
>>> quantum_client = qbraid_core.client('quantum')
>>> device_data = quantum_client.search_devices()
>>> for item in device_data:
... print(item['qbraid_id'])
```
## Community
- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/community/issues)
- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/KugF6Cnncm)
- For questions that are more suited for a forum, post to [Stack Overflow](https://stackoverflow.com/) with the [`qbraid`](https://stackoverflow.com/questions/tagged/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.
[<img src="https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png" width="150">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid.git)
Use the badge in your project's `README.md`:
```markdown
[<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`:
```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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "qbraid-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "qbraid, quantum, cloud",
"author": "qBraid Development Team",
"author_email": "contact@qbraid.com",
"download_url": "https://files.pythonhosted.org/packages/b5/bc/37eafff9ca9dbe58395d9a7712503ea0506ac613b223a52a845dceafd057/qbraid_core-0.1.32.tar.gz",
"platform": null,
"description": "# qbraid-core\n\n[](https://sdk.qbraid.com/projects/core/en/latest/)\n[](https://codecov.io/gh/qBraid/qbraid-core)\n[](https://pypi.org/project/qbraid-core/)\n[](https://pypi.org/project/qbraid-core/)\n[](https://github.com/qBraid/community/issues)\n\nPython 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](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and the\n[jupyter-environment-manager](https://pypi.org/project/jupyter-environment-manager/).\n\nYou can find the latest, most up to date, documentation [here](https://sdk.qbraid.com/projects/core/en/latest/), including a list of services that are supported.\n\n## Getting Started\n\nYou can install qbraid-core from PyPI with:\n\n```bash\npython -m pip install qbraid-core\n```\n\n### Local configuration\n\nAfter installing qbraid-core, you must configure your account credentials:\n\n1. Create a qBraid account or log in to your existing account by visiting\n [account.qbraid.com](https://account.qbraid.com/)\n2. Copy your API Key token from the left side of\n your [account page](https://account.qbraid.com/):\n3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc`, where `~` corresponds to your home (`$HOME`) directory:\n\n```bash\n[default]\napi-key = YOUR_KEY\nurl = https://api.qbraid.com/api\n```\n\nOr generate your `~/.qbraid/qbraidrc` file via the qbraid-core Python interface:\n\n```python\n>>> from qbraid_core import QbraidSession\n>>> session = QbraidSession(api_key='API_KEY')\n>>> session.save_config()\n>>> session.get_available_services()\n['environments', 'quantum']\n```\n\nOther credential configuration methods can be found [here](https://docs.qbraid.com/cli/api-reference/qbraid_configure).\n\n### Verify setup\n\nAfter configuring your qBraid credentials, verify your setup by running the following from a Python interpreter:\n\n```python\n>>> import qbraid_core\n>>> quantum_client = qbraid_core.client('quantum')\n>>> device_data = quantum_client.search_devices()\n>>> for item in device_data:\n... print(item['qbraid_id'])\n```\n\n## Community\n\n- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/community/issues)\n- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/KugF6Cnncm)\n- For questions that are more suited for a forum, post to [Stack Overflow](https://stackoverflow.com/) with the [`qbraid`](https://stackoverflow.com/questions/tagged/qbraid) tag.\n\n## Launch on qBraid\n\nThe \"Launch on qBraid\" button (below) can be added to any public GitHub\nrepository. Clicking on it automaically opens qBraid Lab, and performs a\n`git clone` of the project repo into your account's home directory. Copy the\ncode below, and replace `YOUR-USERNAME` and `YOUR-REPOSITORY` with your GitHub\ninfo.\n\n[<img src=\"https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\" width=\"150\">](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qBraid.git)\n\nUse the badge in your project's `README.md`:\n\n```markdown\n[<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)\n```\n\nUse the badge in your project's `README.rst`:\n\n```rst\n.. image:: https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\n :target: https://account.qbraid.com?gitHubUrl=https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git\n :width: 150px\n```\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Python library with core abstractions for software development in the qBraid ecosystem.",
"version": "0.1.32",
"project_urls": {
"Bug Tracker": "https://github.com/qBraid/community/issues",
"Discord": "https://discord.gg/KugF6Cnncm",
"Documentation": "https://sdk.qbraid.com/projects/core/en/stable/api/qbraid_core.html",
"Homepage": "https://docs.qbraid.com/core"
},
"split_keywords": [
"qbraid",
" quantum",
" cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8966cd498d1bde6d6a40467e1035b86f1c283b6e969b705d045a08bb3287825b",
"md5": "a7d8903a22710305d56ad59997ec448b",
"sha256": "de53e15089d6af3c1313020c765192dfd87e439342e3af186e5c3b6884fa3c23"
},
"downloads": -1,
"filename": "qbraid_core-0.1.32-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7d8903a22710305d56ad59997ec448b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 69320,
"upload_time": "2024-12-19T01:53:19",
"upload_time_iso_8601": "2024-12-19T01:53:19.813954Z",
"url": "https://files.pythonhosted.org/packages/89/66/cd498d1bde6d6a40467e1035b86f1c283b6e969b705d045a08bb3287825b/qbraid_core-0.1.32-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5bc37eafff9ca9dbe58395d9a7712503ea0506ac613b223a52a845dceafd057",
"md5": "4a1078e8eea57e5a7776bad2de96ec29",
"sha256": "a6e94526d63112ade8904748e4d618102b5ed8634dacafe89f71c6813315d906"
},
"downloads": -1,
"filename": "qbraid_core-0.1.32.tar.gz",
"has_sig": false,
"md5_digest": "4a1078e8eea57e5a7776bad2de96ec29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 254211,
"upload_time": "2024-12-19T01:53:22",
"upload_time_iso_8601": "2024-12-19T01:53:22.059735Z",
"url": "https://files.pythonhosted.org/packages/b5/bc/37eafff9ca9dbe58395d9a7712503ea0506ac613b223a52a845dceafd057/qbraid_core-0.1.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 01:53:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qBraid",
"github_project": "community",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "qbraid-core"
}
JSON
