qbraid-cli 0.8.0.dev7__tar.gz → 0.8.1a0__tar.gz

qbraid_cli-0.8.1a0/.env.example

@@ -0,0 +1,4 @@
+QBRAID_API_KEY= # YOURAPIKEY
+QBRAID_ENVS_PATH= # default: ~/.qbraid/environments
+QBRAID_CONFIG_FILE= # default: ~/.qbraid/qbraidrc
+QBRAID_CLI_SHOW_PROGRESS= # default: true

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/.github/workflows/docs.yml

@@ -20,12 +20,12 @@ jobs:
         cache: pip
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools
-        python -m pip install -r docs/requirements.txt
+        python -m pip install --upgrade pip setuptools build
     - name: Build & install package
       run: |
         python -m build .
         python -m pip install dist/*.whl
+        tools/install_wheel_extras.sh dist --extra docs
     - name: Generate docs assets
       run: |
         python -c "import pathlib; pathlib.Path('docs/tree').mkdir(parents=True, exist_ok=True)"

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/.github/workflows/format.yml

@@ -18,17 +18,11 @@ jobs:
       - name: Install dependencies
         run: |
           pip install --upgrade pip
-          pip install black isort pylint
+          pip install black isort pylint qbraid-cli
       - name: Check isort, black, pylint
         run: |
           black --check qbraid_cli tests tools
           isort --check-only qbraid_cli tests tools
-          # if pylint qbraid_cli tests tools --disable=C0415,R0914,W0511 2>&1 | grep 'Your code has been rated at 10\.00/10' > /dev/null; then
-          #   echo "Perfect pylint score!"
-          # else
-          #   echo "Pylint score is not 10/10."
-          #   exit 1
-          # fi
       - name: Check copyright headers
         run: |
-          python tools/verify_headers.py qbraid_cli tests tools --skip qbraid_cli/_version.py
+          qbraid admin headers qbraid_cli tests tools

qbraid_cli-0.8.1a0/.github/workflows/pre-release.yml

@@ -0,0 +1,38 @@
+name: Pre-release to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Build pre-release dist & upload to PyPI
+    environment: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: python -m pip install -U pip wheel build toml-cli qbraid-core
+
+      - name: Build binary wheel + source tarball
+        id: build-dev
+        run: |
+            export PRE_RELEASE_VERSION=$(python tools/stamp_pre_release.py)
+            [[ "$PRE_RELEASE_VERSION" =~ .*(-a\.|-b\.|-rc\.).* ]] && echo "Deploying pre-release version '$PRE_RELEASE_VERSION'" || (echo "not pre-release version"; exit 0)
+            out_dir="${PWD}/dist"
+            tools/create_dev_build.sh $PRE_RELEASE_VERSION "${out_dir}"
+            echo "dir=$out_dir" >> $GITHUB_OUTPUT
+
+      - name: Publish pre-release package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: ${{ steps.build-dev.outputs.dir }}

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/.github/workflows/publish.yml

@@ -1,8 +1,6 @@
 name: Publish to PyPI
 
 on:
-  release:
-    types: [published]
   workflow_dispatch:
 
 jobs:
@@ -18,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Build binary wheel + source tarball
         run: |

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/.readthedocs.yml

@@ -10,9 +10,9 @@ build:
   tools:
     python: "3.10"
   commands:
-    - pip install -r docs/requirements.txt
     - python -m build .
     - python -m pip install dist/*.whl
+    - tools/install_wheel_extras.sh dist --extra docs
     - mkdir -p docs/tree
     - rm -f docs/tree/*.rst
     - typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev7
+Version: 0.8.1a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -39,7 +39,7 @@ Requires-Dist: isort; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: sphinx~=7.2.6; extra == "docs"
+Requires-Dist: sphinx<7.4.0,>=7.2.6; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
 Requires-Dist: docutils<0.22; extra == "docs"
 Requires-Dist: toml; extra == "docs"
@@ -58,17 +58,37 @@ Requires-Dist: typer; extra == "docs"
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
-The **qBraid CLI** is a specialized command-line interface tool designed *exclusively* for use within the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform. It is not intended for local installations or use outside the qBraid Lab environment. This tool ensures seamless integration and optimized performance specifically tailored for qBraid Lab's unique cloud-based quantum computing ecosystem.
+The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/projects/lab/en/latest/lab/quantum_jobs.html), enabling direct acess to QPU devices from leading providers like IonQ, Oxford Quantum Circuits, QuEra, and Rigetti, as well as on-demand simulators from AWS, all using qBraid credits, with no additional access keys required.
 
 ## Getting Started
 
-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) using the ``!`` operator. See [quantum jobs example](https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb).
+The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
 
 - [Launch qBraid Lab &rarr;](https://lab.qbraid.com/)
 - [Make an account &rarr;](https://account.qbraid.com/)
 
 For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).
 
+You can also install the qBraid-CLI from PyPI with:
+
+```shell
+pip install qbraid-cli
+```
+
+## Local configuration
+
+After installation, you must configure your account credentials to use the CLI locally:
+
+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` using:
+
+```shell
+$ qbraid configure
+```
+
 ## Basic Commands
 
 ```shell
@@ -141,3 +161,25 @@ To get the version of the qBraid CLI:
 ```shell
 $ qbraid --version
 ```
+
+## Magic Commands
+
+You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
+
+```shell
+$ qbraid configure magic
+```
+
+The above command can also be executed from within a Jupyter notebook using the ``!`` operator. Then, from within a notebook cell, load the qBraid magic IPython extension using:
+
+```python
+In [1]: %load_ext qbraid_magic
+```
+
+Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.
+
+```python
+In [2]: %qbraid jobs state
+
+In [3]: %qbraid jobs enable braket -y
+```

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/README.md

@@ -9,17 +9,37 @@
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
-The **qBraid CLI** is a specialized command-line interface tool designed *exclusively* for use within the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform. It is not intended for local installations or use outside the qBraid Lab environment. This tool ensures seamless integration and optimized performance specifically tailored for qBraid Lab's unique cloud-based quantum computing ecosystem.
+The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/projects/lab/en/latest/lab/quantum_jobs.html), enabling direct acess to QPU devices from leading providers like IonQ, Oxford Quantum Circuits, QuEra, and Rigetti, as well as on-demand simulators from AWS, all using qBraid credits, with no additional access keys required.
 
 ## Getting Started
 
-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) using the ``!`` operator. See [quantum jobs example](https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb).
+The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
 
 - [Launch qBraid Lab →](https://lab.qbraid.com/)
 - [Make an account →](https://account.qbraid.com/)
 
 For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).
 
+You can also install the qBraid-CLI from PyPI with:
+
+```shell
+pip install qbraid-cli
+```
+
+## Local configuration
+
+After installation, you must configure your account credentials to use the CLI locally:
+
+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` using:
+
+```shell
+$ qbraid configure
+```
+
 ## Basic Commands
 
 ```shell
@@ -92,3 +112,25 @@ To get the version of the qBraid CLI:
 ```shell
 $ qbraid --version
 ```
+
+## Magic Commands
+
+You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
+
+```shell
+$ qbraid configure magic
+```
+
+The above command can also be executed from within a Jupyter notebook using the ``!`` operator. Then, from within a notebook cell, load the qBraid magic IPython extension using:
+
+```python
+In [1]: %load_ext qbraid_magic
+```
+
+Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.
+
+```python
+In [2]: %qbraid jobs state
+
+In [3]: %qbraid jobs enable braket -y
+```

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.0.dev7"
+version = "0.8.1-alpha"
 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" }]
@@ -45,7 +45,7 @@ Discord = "https://discord.gg/KugF6Cnncm"
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
 dev = ["black", "isort", "pylint", "pytest"]
-docs = ["sphinx~=7.2.6", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.22", "toml", "build", "m2r", "typer"]
+docs = ["sphinx>=7.2.6,<7.4.0", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.22", "toml", "build", "m2r", "typer"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli/_version.py

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

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli/admin/headers.py

@@ -6,11 +6,13 @@ Script to verify qBraid copyright file headers
 
 """
 import os
-import sys
 from typing import List, Optional
 
+import typer
 from rich.console import Console
 
+from qbraid_cli.handlers import handle_error
+
 # pylint: disable=too-many-branches,too-many-statements
 
 DEFAULT_HEADER = """# Copyright (c) 2024, qBraid Development Team
@@ -43,19 +45,17 @@ def check_and_fix_headers(
     """Script to add or verify qBraid copyright file headers"""
     try:
         header = HEADER_TYPES[header_type]
-    except KeyError as err:
-        raise ValueError(
-            f"Invalid header type: {HEADER_TYPES}. Expected one of {list(HEADER_TYPES.keys())}"
-        ) from err
+    except KeyError:
+        handle_error(
+            error_type="ValueError",
+            message=(
+                f"Invalid header type: {HEADER_TYPES}. Expected one of {list(HEADER_TYPES.keys())}"
+            ),
+        )
 
     for path in src_paths:
         if not os.path.exists(path):
-            sys.stderr.write(
-                f"Usage: qbraid verify_headers [OPTIONS] SRC ...\n"
-                f"Try 'qbraid verify_headers --help' for help.\n\n"
-                f"Error: Invalid value for 'SRC ...': Path '{path}' does not exist.\n"
-            )
-            sys.exit(1)
+            handle_error(error_type="FileNotFoundError", message=f"Path '{path}' does not exist.")
 
     header_2023 = header.replace("2024", "2023")
 
@@ -139,8 +139,11 @@ def check_and_fix_headers(
             replace_or_add_header(item, fix)
             checked += 1
         else:
-            failed_headers.append(item)
-            print(f"File or directory not found: {item}")
+            handle_error(error_type="FileNotFoundError", message=f"Path '{item}' does not exist.")
+
+    if checked == 0:
+        console.print("[bold]No Python files present. Nothing to do[/bold] 😴")
+        raise typer.Exit(0)
 
     if not fix:
         if failed_headers:
@@ -160,34 +163,31 @@ def check_and_fix_headers(
 
             failed_msg = f"[bold][blue]{num_failed}[/blue] file{s1} need{s2} updating{punc}[/bold]"
             console.print(f"{failed_msg}{passed_msg}")
-        elif checked == 0:
-            console.print("[bold]No Python files present. Nothing to do[/bold] 😴")
-        else:
-            s_checked = "" if checked == 1 else "s"
-            console.print("[bold]All done![/bold] ✨ 🚀 ✨")
-            console.print(f"[blue]{checked}[/blue] file{s_checked} would be left unchanged.")
-
+            raise typer.Exit(1)
+
+        s_checked = "" if checked == 1 else "s"
+        console.print("[bold]All done![/bold] ✨ 🚀 ✨")
+        console.print(f"[blue]{checked}[/blue] file{s_checked} would be left unchanged.")
+        raise typer.Exit(0)
+
+    for file in fixed_headers:
+        console.print(f"[bold]fixed {file}[/bold]")
+    num_fixed = len(fixed_headers)
+    num_ok = checked - num_fixed
+    s_fixed = "" if num_fixed == 1 else "s"
+    s_ok = "" if num_ok == 1 else "s"
+    console.print("\n[bold]All done![/bold] ✨ 🚀 ✨")
+    if num_ok > 0:
+        punc = ", "
+        unchanged_msg = f"[blue]{num_ok}[/blue] file{s_ok} left unchanged."
     else:
-        for file in fixed_headers:
-            console.print(f"[bold]fixed {file}[/bold]")
-        num_fixed = len(fixed_headers)
-        num_ok = checked - num_fixed
-        s_fixed = "" if num_fixed == 1 else "s"
-        s_ok = "" if num_ok == 1 else "s"
-        console.print("\n[bold]All done![/bold] ✨ 🚀 ✨")
-        if num_ok > 0:
-            punc = ", "
-            unchanged_msg = f"[blue]{num_ok}[/blue] file{s_ok} left unchanged."
-        else:
-            punc = "."
-            unchanged_msg = ""
+        punc = "."
+        unchanged_msg = ""
 
-        if num_fixed > 0:
-            fixed_msg = f"[bold][blue]{num_fixed}[/blue] file{s_fixed} fixed{punc}[/bold]"
-        else:
-            fixed_msg = ""
+    if num_fixed > 0:
+        fixed_msg = f"[bold][blue]{num_fixed}[/blue] file{s_fixed} fixed{punc}[/bold]"
+    else:
+        fixed_msg = ""
 
-        if fixed_msg or unchanged_msg:
-            console.print(f"{fixed_msg}{unchanged_msg}")
-        else:
-            console.print("[bold]No Python files present. Nothing to do[/bold] 😴")
+    console.print(f"{fixed_msg}{unchanged_msg}")
+    raise typer.Exit(0)

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli/credits/app.py

@@ -24,8 +24,11 @@ def credits_value():
         return client.user_credits_value()
 
     qbraid_credits: float = run_progress_task(get_credits)
-    credits_text = typer.style(f"{qbraid_credits:.2f}", fg=typer.colors.GREEN, bold=True)
-    typer.secho(f"\nqBraid credits: {credits_text}")
+    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)
+    )
 
 
 if __name__ == "__main__":

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli/handlers.py

@@ -7,6 +7,7 @@ and executing operations with progress tracking within the qBraid CLI.
 
 """
 
+import os
 import traceback
 from pathlib import Path
 from typing import Any, Callable, List, Optional, Union
@@ -18,6 +19,11 @@ from rich.progress import Progress, SpinnerColumn, TextColumn
 from .exceptions import DEFAULT_ERROR_MESSAGE, QbraidException
 
 
+def _should_display_progress():
+    """Whether to display rich progress UI."""
+    return os.getenv("QBRAID_CLI_SHOW_PROGRESS", "true").lower() in ["true", "1", "t", "y", "yes"]
+
+
 def handle_error(
     error_type: Optional[str] = None, message: Optional[str] = None, include_traceback: bool = True
 ) -> None:
@@ -104,6 +110,13 @@ def run_progress_task(
     Raises:
         typer.Exit: If the operation fails, after displaying the error message using typer.secho.
     """
+    if not _should_display_progress():
+        try:
+            return operation(*args, **kwargs)
+        except Exception as err:  # pylint: disable=broad-exception-caught
+            custom_message = error_message if error_message else str(err)
+            return handle_error(message=custom_message)
+
     console = Console()
     with Progress(
         "[progress.description]{task.description}",
@@ -117,9 +130,9 @@ def run_progress_task(
             result = operation(*args, **kwargs)
             progress.update(task, completed=100, status="Done")
             return result
-        except Exception as e:  # pylint: disable=broad-exception-caught
+        except Exception as err:  # pylint: disable=broad-exception-caught
             progress.update(task, completed=100, status="Failed")
-            custom_message = error_message if error_message else str(e)
+            custom_message = error_message if error_message else str(err)
             return handle_error(message=custom_message)
 
 

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli/main.py

@@ -30,10 +30,11 @@ app.add_typer(kernels_app, name="kernels")
 def version_callback(value: bool):
     """Show the version and exit."""
     if value:
-        from ._version import __version__
+        # pylint: disable-next=import-error
+        from ._version import __version__  # type: ignore
 
         typer.echo(f"qbraid-cli/{__version__}")
-        raise typer.Exit()
+        raise typer.Exit(0)
 
 
 def show_banner():

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev7
+Version: 0.8.1a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -39,7 +39,7 @@ Requires-Dist: isort; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: sphinx~=7.2.6; extra == "docs"
+Requires-Dist: sphinx<7.4.0,>=7.2.6; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
 Requires-Dist: docutils<0.22; extra == "docs"
 Requires-Dist: toml; extra == "docs"
@@ -58,17 +58,37 @@ Requires-Dist: typer; extra == "docs"
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
-The **qBraid CLI** is a specialized command-line interface tool designed *exclusively* for use within the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform. It is not intended for local installations or use outside the qBraid Lab environment. This tool ensures seamless integration and optimized performance specifically tailored for qBraid Lab's unique cloud-based quantum computing ecosystem.
+The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/projects/lab/en/latest/lab/quantum_jobs.html), enabling direct acess to QPU devices from leading providers like IonQ, Oxford Quantum Circuits, QuEra, and Rigetti, as well as on-demand simulators from AWS, all using qBraid credits, with no additional access keys required.
 
 ## Getting Started
 
-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) using the ``!`` operator. See [quantum jobs example](https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb).
+The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
 
 - [Launch qBraid Lab &rarr;](https://lab.qbraid.com/)
 - [Make an account &rarr;](https://account.qbraid.com/)
 
 For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).
 
+You can also install the qBraid-CLI from PyPI with:
+
+```shell
+pip install qbraid-cli
+```
+
+## Local configuration
+
+After installation, you must configure your account credentials to use the CLI locally:
+
+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` using:
+
+```shell
+$ qbraid configure
+```
+
 ## Basic Commands
 
 ```shell
@@ -141,3 +161,25 @@ To get the version of the qBraid CLI:
 ```shell
 $ qbraid --version
 ```
+
+## Magic Commands
+
+You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
+
+```shell
+$ qbraid configure magic
+```
+
+The above command can also be executed from within a Jupyter notebook using the ``!`` operator. Then, from within a notebook cell, load the qBraid magic IPython extension using:
+
+```python
+In [1]: %load_ext qbraid_magic
+```
+
+Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.
+
+```python
+In [2]: %qbraid jobs state
+
+In [3]: %qbraid jobs enable braket -y
+```

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli.egg-info/SOURCES.txt

@@ -12,13 +12,12 @@ pyproject.toml
 .github/workflows/docs.yml
 .github/workflows/format.yml
 .github/workflows/main.yml
+.github/workflows/pre-release.yml
 .github/workflows/publish.yml
-.github/workflows/test-publish.yml
 docs/Makefile
 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
@@ -124,5 +123,7 @@ tests/test_jobs/test_validation/test_run_progress_get_state.py
 tests/test_jobs/test_validation/test_validate_library.py
 tests/test_kernels/__init__.py
 tests/test_kernels/test_kernels_list.py
+tools/create_dev_build.sh
+tools/install_wheel_extras.sh
 tools/split_rst.py
-tools/verify_headers.py
+tools/stamp_pre_release.py

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/qbraid_cli.egg-info/requires.txt

@@ -11,7 +11,7 @@ pylint
 pytest
 
 [docs]
-sphinx~=7.2.6
+sphinx<7.4.0,>=7.2.6
 sphinx-rtd-theme<2.1,>=1.3
 docutils<0.22
 toml

{qbraid_cli-0.8.0.dev7 → qbraid_cli-0.8.1a0}/tests/test_credits/test_credits_value.py

@@ -28,7 +28,7 @@ def test_credits_value_success():
         session = QbraidSession(api_key=qbraid_api_key)
         session.save_config()
 
-        mock_response = float(100)
+        mock_response = float(100.457321)
         mock_qbraid_client.return_value = mock_response
 
         # Setup mock for run_progress_task to return the credits directly
@@ -36,6 +36,6 @@ def test_credits_value_success():
 
         result = runner.invoke(credits_app)
 
-        assert "qBraid credits:" in result.output
-        assert "100.00" in result.output
+        assert "qBraid credits remaining:" in result.output
+        assert "100.4573" in result.output
         assert result.exit_code == 0