qbraid-cli 0.8.7__tar.gz → 0.9.0a0__tar.gz

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/.github/workflows/docs.yml

@@ -3,12 +3,14 @@ name: Build Docs
 on:
   pull_request:
     branches: ['main']
+    types: [opened, reopened, ready_for_review, synchronize]
   push:
     branches: ['main']
   workflow_dispatch:
 
 jobs:
   build:
+    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
 
     steps:
@@ -25,7 +27,7 @@ jobs:
     - name: Build & install package
       run: |
         python -m build .
-        python -m pip install dist/*.whl
+        tools/install_wheel_extras.sh dist --extra envs
     - name: Generate docs assets
       run: |
         python -c "import pathlib; pathlib.Path('docs/tree').mkdir(parents=True, exist_ok=True)"

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/.github/workflows/format.yml

@@ -1,12 +1,14 @@
-name: Formatting check
+name: Format
 
 on:
   pull_request:
       branches: ['main']
+      types: [opened, reopened, ready_for_review, synchronize]
   workflow_dispatch:
 
 jobs:
-  main:
+  check:
+    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
 
     steps:

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/.github/workflows/main.yml

@@ -3,12 +3,14 @@ name: CI
 on:
   pull_request:
     branches: ['main']
+    types: [opened, reopened, ready_for_review, synchronize]
   push:
     branches: ['main']
   workflow_dispatch:
 
 jobs:
   build:
+    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -35,6 +37,7 @@ jobs:
           path: dist/*.whl
 
   test:
+    if: github.event.pull_request.draft == false
     needs: build
     runs-on: ${{ matrix.os }}
     strategy:
@@ -64,7 +67,7 @@ jobs:
         shell: pwsh
       - name: Install testing dependencies
         run: |
-          pip install pytest pytest-cov
+          pip install pytest pytest-cov qbraid-core[environments]
       - name: Run tests with pytest
         run: |
           pytest --cov=qbraid_cli tests/ --cov-report=html --cov-report=xml --cov-report=term --cov-config=pyproject.toml

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/CONTRIBUTING.md

@@ -1,10 +1,8 @@
 # Contributing
 
 [![CI](https://github.com/qBraid/qBraid-CLI/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/qBraid/qBraid-CLI/actions/workflows/main.yml)
-[![Documentation Status](https://readthedocs.com/projects/qbraid-qbraid-cli/badge/?version=latest)](https://docs.qbraid.com/projects/cli/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/qBraid/qBraid-CLI/graph/badge.svg?token=wVNrLILy9c)](https://codecov.io/gh/qBraid/qBraid-CLI)
 
-
 Welcome! We're delighted that you're interested in contributing. Your help is essential for keeping the project great.
 
 ## Getting Started
@@ -99,17 +97,20 @@ open docs/build/html/index.html
 
 ## Code style
 
-For code style, our project uses [ruff](https://github.com/astral-sh/ruff). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
+For code style, our project uses a combination of [isort](https://github.com/PyCQA/isort), [pylint](https://github.com/pylint-dev/pylint), [black](https://github.com/psf/black), and [mypy](https://github.com/python/mypy). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
 
 Install linters:
 
 ```bash
-pip install ruff qbraid-cli
+pip install black isort pylint mypy
 ```
 
 Run the following and make changes as needed to satisfy format checks:
 
 ```bash
-ruff format qbraid_cli tests tools
+black qbraid_cli tests tools
+isort qbraid_cli tests tools
+pylint qbraid_cli tests tools
+mypy qbraid_cli tests tools
 qbraid admin headers qbraid_cli tests tools --type=default --fix
 ```

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/Makefile

@@ -16,15 +16,21 @@ help: ## Display this help message
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-30s\033[0m %s\n", $$1, $$2}'
 	@echo
 
-docs: check_dependencies_docs check_build_version ## Generate documentation
+docs: check_dependencies_docs check_build_version ## Generate documentation (Sphinx)
 	@python -c "import pathlib; pathlib.Path('$(TREE_DIR)').mkdir(parents=True, exist_ok=True)"
-	@python -c "import glob, os; [os.remove(f) for f in glob.glob('$(TREE_DIR)/*.rst')]"
+	@python -c "import glob, os; [os.remove(f) for f in glob.glob('$(TREE_DIR)/*')]"
 	@typer qbraid_cli.main utils docs --name=qbraid --output=$(TREE_DIR)/qbraid.md
 	@m2r $(TREE_DIR)/qbraid.md
 	@python -c "import os; os.remove('$(TREE_DIR)/qbraid.md')"
 	@python $(TOOLS_DIR)/split_rst.py $(TREE_DIR)/qbraid.rst
 	@sphinx-build -W -b html $(DOCS_DIR) $(BUILD_DIR)
 
+docs-mdx: check_dependencies_docs check_build_version ## Generate documentation (Mintlify)
+	@python -c "import pathlib; pathlib.Path('$(TREE_DIR)').mkdir(parents=True, exist_ok=True)"
+	@python -c "import glob, os; [os.remove(f) for f in glob.glob('$(TREE_DIR)/*')]"
+	@typer qbraid_cli.main utils docs --name=qbraid --output=$(TREE_DIR)/qbraid.md
+	@python $(TOOLS_DIR)/split_md.py $(TREE_DIR)/qbraid.md
+
 test: check_dependencies_test ## Run tests with pytest
 	@python -m pytest $(TESTS_DIR)
 

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.7
+Version: 0.9.0a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,11 +29,12 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: qbraid-core[environments]>=0.1.23
+Requires-Dist: qbraid-core>=0.1.28
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
+Provides-Extra: envs
+Requires-Dist: qbraid-core[environments]; extra == "envs"
 Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -141,7 +142,7 @@ Options
 
 Commands
   configure                     Configure qBraid CLI options.
-  credits                       Manage qBraid credits.
+  account                       Manage qBraid account.
   devices                       Manage qBraid quantum devices.
   envs                          Manage qBraid environments.
   jobs                          Manage qBraid quantum jobs.

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/README.md

@@ -100,7 +100,7 @@ Options
 
 Commands
   configure                     Configure qBraid CLI options.
-  credits                       Manage qBraid credits.
+  account                       Manage qBraid account.
   devices                       Manage qBraid quantum devices.
   envs                          Manage qBraid environments.
   jobs                          Manage qBraid quantum jobs.

qbraid_cli-0.8.7/docs/guide/overview.rst → qbraid_cli-0.9.0a0/docs/index.rst

@@ -1,7 +1,5 @@
-.. _cli_overview:
-
-Overview
-=========
+Documentation
+==============
 
 .. raw:: html
 
@@ -33,7 +31,7 @@ the qBraid CLI can be intalled using `pip <https://pypi.org/project/qbraid-cli/>
    pip install qbraid-cli
 
 To use the qBraid CLI, login to qBraid (or create an account), launch Lab, and then open Terminal.
-You can also access the CLI directly from within `Notebooks <https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html>`_
+You can also access the CLI directly from within `Notebooks <https://docs.qbraid.com/lab/user-guide/notebooks>`_
 using the ``!`` operator. See `quantum jobs example <https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb>`_.
 
 - `Launch qBraid Lab → <https://lab.qbraid.com/>`_
@@ -107,3 +105,19 @@ by disabling quantum jobs:
 .. code-block:: console
 
    $ qbraid jobs disable braket  # toggle quantum jobs off
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: CLI API Reference
+   :hidden:
+
+   tree/qbraid
+   tree/qbraid_admin
+   tree/qbraid_configure
+   tree/qbraid_account
+   tree/qbraid_devices
+   tree/qbraid_envs
+   tree/qbraid_jobs
+   tree/qbraid_kernels
+   tree/qbraid_pip

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.7"
+version = "0.9.0a0"
 description = "Command Line Interface for interacting with all parts of the qBraid platform."
 readme = "README.md"
 authors = [{ name = "qBraid Development Team", email = "contact@qbraid.com" }]
@@ -30,7 +30,7 @@ classifiers = [
 dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
-    "qbraid-core[environments]>=0.1.23",
+    "qbraid-core>=0.1.28",
 ]
 requires-python = ">= 3.9"
 
@@ -42,7 +42,8 @@ Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
-dev = ["ruff", "isort", "black", "pytest", "pytest-cov"]
+envs = ["qbraid-core[environments]"]
+dev = ["isort", "black", "pytest", "pytest-cov"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"
@@ -52,7 +53,7 @@ write_to = "qbraid_cli/_version.py"
 
 [tool.black]
 line-length = 100
-target-version = ["py39", "py310", "py311"]
+target-version = ["py39", "py310", "py311", "py312"]
 
 [tool.isort]
 profile = "black"

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/qbraid_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.dev1+g49939c4'
-__version_tuple__ = version_tuple = (0, 1, 'dev1', 'g49939c4')
+__version__ = version = '0.1.dev1+ge41229b.d20241106'
+__version_tuple__ = version_tuple = (0, 1, 'dev1', 'ge41229b.d20241106')

qbraid_cli-0.9.0a0/qbraid_cli/account/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining the qbraid account namespace
+
+"""
+
+from .app import account_app
+
+__all__ = ["account_app"]

qbraid_cli-0.9.0a0/qbraid_cli/account/app.py

@@ -0,0 +1,65 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid user' namespace.
+
+"""
+
+from typing import Any
+
+import rich
+import typer
+
+from qbraid_cli.handlers import run_progress_task
+
+account_app = typer.Typer(help="Manage qBraid account.")
+
+
+@account_app.command(name="credits")
+def account_credits():
+    """Get number of qBraid credits remaining."""
+
+    def get_credits() -> float:
+        from qbraid_core import QbraidClient
+
+        client = QbraidClient()
+        return client.user_credits_value()
+
+    qbraid_credits: float = run_progress_task(get_credits)
+    typer.secho(
+        f"\n{typer.style('qBraid credits remaining:')} "
+        f"{typer.style(f'{qbraid_credits:.4f}', fg=typer.colors.MAGENTA, bold=True)}",
+        nl=True,  # Ensure a newline after output (default is True)
+    )
+    rich.print("\nFor more information, visit: https://docs.qbraid.com/home/pricing#credits")
+
+
+@account_app.command(name="info")
+def account_info():
+    """Get qBraid account (user) metadata."""
+
+    def get_user() -> dict[str, Any]:
+        from qbraid_core import QbraidSession
+
+        session = QbraidSession()
+        user = session.get_user()
+        personal_info: dict = user.get("personalInformation", {})
+        metadata = {
+            "_id": user.get("_id"),
+            "userName": user.get("userName"),
+            "email": user.get("email"),
+            "joinedDate": user.get("createdAt", "Unknown"),
+            "activePlan": user.get("activePlan", "") or "Free",
+            "organization": personal_info.get("organization", "") or "qbraid",
+            "role": personal_info.get("role", "") or "guest",
+        }
+
+        return metadata
+
+    info = run_progress_task(get_user)
+    rich.print(info)
+
+
+if __name__ == "__main__":
+    account_app()

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/qbraid_cli/main.py

@@ -8,25 +8,33 @@ Entrypoint for the qBraid CLI.
 
 import typer
 
+from qbraid_cli.account.app import account_app
 from qbraid_cli.admin.app import admin_app
 from qbraid_cli.configure.app import configure_app
-from qbraid_cli.credits.app import credits_app
 from qbraid_cli.devices.app import devices_app
-from qbraid_cli.envs.app import envs_app
 from qbraid_cli.jobs.app import jobs_app
-from qbraid_cli.kernels.app import kernels_app
-from qbraid_cli.pip.app import pip_app
+
+try:
+    from qbraid_cli.envs.app import envs_app
+    from qbraid_cli.kernels.app import kernels_app
+    from qbraid_cli.pip.app import pip_app
+
+    ENVS_COMMANDS = True
+except ImportError:
+    ENVS_COMMANDS = False
 
 app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
 
 app.add_typer(admin_app, name="admin")
 app.add_typer(configure_app, name="configure")
-app.add_typer(credits_app, name="credits")
+app.add_typer(account_app, name="account")
 app.add_typer(devices_app, name="devices")
-app.add_typer(envs_app, name="envs")
 app.add_typer(jobs_app, name="jobs")
-app.add_typer(kernels_app, name="kernels")
-app.add_typer(pip_app, name="pip")
+
+if ENVS_COMMANDS is True:
+    app.add_typer(envs_app, name="envs")
+    app.add_typer(kernels_app, name="kernels")
+    app.add_typer(pip_app, name="pip")
 
 
 def version_callback(value: bool):

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/qbraid_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.7
+Version: 0.9.0a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,11 +29,12 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: qbraid-core[environments]>=0.1.23
+Requires-Dist: qbraid-core>=0.1.28
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
+Provides-Extra: envs
+Requires-Dist: qbraid-core[environments]; extra == "envs"
 Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -141,7 +142,7 @@ Options
 
 Commands
   configure                     Configure qBraid CLI options.
-  credits                       Manage qBraid credits.
+  account                       Manage qBraid account.
   devices                       Manage qBraid quantum devices.
   envs                          Manage qBraid environments.
   jobs                          Manage qBraid quantum jobs.

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/qbraid_cli.egg-info/SOURCES.txt

@@ -7,7 +7,6 @@ MANIFEST.IN
 Makefile
 README.md
 pyproject.toml
-ruff.toml
 .github/PULL_REQUEST_TEMPLATE.md
 .github/ISSUE_TEMPLATE/bug_report.yml
 .github/ISSUE_TEMPLATE/feature_request.yml
@@ -23,30 +22,10 @@ docs/conf.py
 docs/index.rst
 docs/make.bat
 docs/requirements.txt
-docs/_static/api-key.png
 docs/_static/favicon.ico
 docs/_static/logo.png
-docs/_static/cards/jupyter.png
-docs/_static/cards/python.png
-docs/_static/cards/terminal.png
 docs/_static/style/custom.css
 docs/_static/style/s4defs-roles.css
-docs/cli/configure.rst
-docs/cli/credits.rst
-docs/cli/devices-list.rst
-docs/cli/devices.rst
-docs/cli/envs-activate.rst
-docs/cli/envs-list.rst
-docs/cli/envs-uninstall.rst
-docs/cli/envs.rst
-docs/cli/jobs-add.rst
-docs/cli/jobs-disable.rst
-docs/cli/jobs-enable.rst
-docs/cli/jobs-list.rst
-docs/cli/jobs.rst
-docs/cli/kernels.rst
-docs/cli/qbraid.rst
-docs/guide/overview.rst
 qbraid_cli/__init__.py
 qbraid_cli/_version.py
 qbraid_cli/exceptions.py
@@ -59,6 +38,8 @@ qbraid_cli.egg-info/dependency_links.txt
 qbraid_cli.egg-info/entry_points.txt
 qbraid_cli.egg-info/requires.txt
 qbraid_cli.egg-info/top_level.txt
+qbraid_cli/account/__init__.py
+qbraid_cli/account/app.py
 qbraid_cli/admin/__init__.py
 qbraid_cli/admin/app.py
 qbraid_cli/admin/headers.py
@@ -66,8 +47,6 @@ qbraid_cli/admin/validation.py
 qbraid_cli/configure/__init__.py
 qbraid_cli/configure/actions.py
 qbraid_cli/configure/app.py
-qbraid_cli/credits/__init__.py
-qbraid_cli/credits/app.py
 qbraid_cli/devices/__init__.py
 qbraid_cli/devices/app.py
 qbraid_cli/devices/validation.py
@@ -86,13 +65,13 @@ qbraid_cli/pip/__init__.py
 qbraid_cli/pip/app.py
 qbraid_cli/pip/hooks.py
 tests/__init__.py
+tests/account/__init__.py
+tests/account/test_account_credits.py
 tests/admin/test_headers.py
 tests/configure/__init__.py
 tests/configure/test_configure_prompt_for_config.py
 tests/configure/test_configure_set.py
 tests/configure/test_configure_validate_input.py
-tests/credits/__init__.py
-tests/credits/test_credits_value.py
 tests/devices/__init__.py
 tests/devices/test_devices_list.py
 tests/devices/test_devices_validations.py

{qbraid_cli-0.8.7 → qbraid_cli-0.9.0a0}/qbraid_cli.egg-info/requires.txt

@@ -1,13 +1,15 @@
 typer>=0.12.1
 rich>=10.11.0
-qbraid-core[environments]>=0.1.23
+qbraid-core>=0.1.28
 
 [dev]
-ruff
 isort
 black
 pytest
 pytest-cov
 
+[envs]
+qbraid-core[environments]
+
 [jobs]
 amazon-braket-sdk>=1.48.1

qbraid_cli-0.9.0a0/tests/account/test_account_credits.py

@@ -0,0 +1,88 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Unit tests for the 'qbraid account credits' command.
+
+"""
+
+from unittest.mock import patch
+
+from typer.testing import CliRunner
+
+from qbraid_cli.account import account_app
+
+runner = CliRunner()
+
+
+def test_account_credits_success():
+    """Test the 'qbraid account credts' command with a successful response."""
+    credits_value = 100.4573
+
+    class MockQbraidClient:  # pylint: disable=too-few-public-methods
+        """Mock class for the QbraidClient."""
+
+        def user_credits_value(self):
+            """ "Mock user_credits_value method."""
+            return credits_value
+
+    with (
+        patch("qbraid_cli.handlers.run_progress_task") as mock_run_progress_task,
+        patch("qbraid_core.QbraidClient") as mock_qbraid_client,
+    ):
+        mock_response = credits_value
+        mock_qbraid_client.return_value = MockQbraidClient()
+
+        # Setup mock for run_progress_task to return the credits directly
+        mock_run_progress_task.return_value = mock_response
+
+        result = runner.invoke(account_app, ["credits"])
+
+        assert result.exit_code == 0
+        assert "qBraid credits remaining:" in result.output
+        assert str(credits_value) in result.output
+
+
+def test_account_info_success():
+    """Test the 'qbraid account info' command with a successful response."""
+    mock_info = {
+        "_id": "123456789",
+        "userName": "mockUser",
+        "email": "mock@example.com",
+        "joinedDate": "2022-03-10T03:52:08.743Z",
+        "activePlan": "Free",
+        "organization": "qbraid",
+        "role": "guest",
+    }
+
+    class MockQbraidSession:  # pylint: disable=too-few-public-methods
+        """Mock class for the QbraidSession."""
+
+        def get_user(self):
+            """ "Mock get_user method."""
+            return {
+                "_id": "123456789",
+                "userName": "mockUser",
+                "email": "mock@example.com",
+                "createdAt": "2022-03-10T03:52:08.743Z",
+                "activePlan": "Free",
+                "organization": "qbraid",
+                "role": "guest",
+            }
+
+    with (
+        patch("qbraid_cli.handlers.run_progress_task") as mock_run_progress_task,
+        patch("qbraid_core.QbraidSession") as mock_qbraid_session,
+    ):
+        mock_response = mock_info
+        mock_qbraid_session.return_value = MockQbraidSession()
+
+        # Setup mock for run_progress_task to return the user info directly
+        mock_run_progress_task.return_value = mock_response
+
+        result = runner.invoke(account_app, ["info"])
+
+        assert result.exit_code == 0
+        for key, value in mock_info.items():
+            assert key in result.output
+            assert str(value) in result.output

qbraid_cli-0.8.7/docs/cli/configure.rst

@@ -1,60 +0,0 @@
-.. _cli_configure:
-
-qbraid configure
-=================
-
-Update or add qbraidrc config/credential values.
-
-.. code-block:: bash
-
-    qbraid configure
-
-
-The qbraid configure command streamlines the setup of your qBraid CLI installation
-by allowing you to manage and save frequently used credentials and configurations directly
-from your preferred terminal. Upon executing ``qbraid configure``, the CLI will prompt you
-for necessary credentials and configuration details. Unless a specific profile is designated,
-these details are automatically stored under the ``[default]`` section in your local ``qbraidrc``
-file. This file is located in the ``.qbraid`` folder within your home directory.
-
-
-Examples
----------
-
-.. code-block:: console
-
-    $ qbraid configure
-    email [None]: contact@qbraid.com
-    api-key [None]: 1234567890
-
-
-This input will result in the following configuration in ``~/.qbraid/qbraidrc``:
-
-
-.. code-block:: bash
-
-    [default]
-    url = https://api.qbraid.com/api
-    email = contact@qbraid.com
-    api-key = 1234567890
-
-
-.. image:: ../_static/api-key.png
-    :align: right
-    :width: 300px
-    :alt: Access key
-    :target: javascript:void(0);
-
-Get API key
----------------
-
-To use certain qBraid CLI and `qBraid-SDK <https://docs.qbraid.com/en/latest/sdk/overview.html>`_ features locally (outside of `qBraid Lab <https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html>`_), you must add your account credentials.
-Use the following steps to retrieve your API key:
-
-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>`_.
-
-.. seealso::
-
-    - `qBraid User Guide: Account <https://docs.qbraid.com/projects/lab/en/latest/lab/account.html>`_