qbraid-cli 0.8.0.dev7__py3-none-any.whl → 0.8.1a0__py3-none-any.whl

qbraid_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.8.0.dev7'
-__version_tuple__ = version_tuple = (0, 8, 0, 'dev7')
+__version__ = version = '0.8.1a0'
+__version_tuple__ = version_tuple = (0, 8, 1)

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/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/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/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.dist-info → qbraid_cli-0.8.1a0.dist-info}/METADATA

@@ -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
@@ -37,7 +37,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: amazon-braket-sdk >=1.48.1 ; extra == 'jobs'
 
 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.dist-info → qbraid_cli-0.8.1a0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qbraid_cli/_version.py,sha256=LlNqfqEKaHtz__4TUC6OnHia_u-wZZrbjkS5UKENpH0,424
+qbraid_cli/_version.py,sha256=uh6qRUKYp5CUuk-ID8cyEoLnsVpY7iGTUwo68466d6k,413
 qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
-qbraid_cli/handlers.py,sha256=i3vdRtdy4bZKg3j6fwfVMz1ddhMgzlc2hhmj-vewxpI,6542
-qbraid_cli/main.py,sha256=IRKazFqtFpoiq_xOtqb-IXDKAVs4lacFIRCQCoiGNF4,2503
+qbraid_cli/handlers.py,sha256=glxTEwxax3zKgYl9qsZ2evZXgrWQrseJS_OGyHTMFeA,7040
+qbraid_cli/main.py,sha256=R26PkxijuuCzcW_PVREHb11oNlNN2rWDcRY7BmiDV0Q,2564
 qbraid_cli/admin/__init__.py,sha256=Suo_L1_yBodCvLM_fpw8gRIhD4mVVOXKObtxeoMaBVo,150
 qbraid_cli/admin/app.py,sha256=__6lo-iFsbfz-ayD1-AS8X1z_gYhCad1NK17hnrL7HY,1451
-qbraid_cli/admin/headers.py,sha256=oE2Ry9221ZV4tgYqFJNHAPilDw72xR3LqG_gBw7BFxM,6667
+qbraid_cli/admin/headers.py,sha256=E6mE3odZL57VfHHZxYtRUkqMKmrmT4zuUoINzI7eJF8,6435
 qbraid_cli/admin/validation.py,sha256=LkAVXlHtM0MhCa34MIWrfX59wGXMVlZmdVB4-AQ8fBk,1003
 qbraid_cli/configure/__init__.py,sha256=6GU7vR6JYRGcMsmdrpFbwLO5VSUmnLgwSbtmGWMQND4,158
 qbraid_cli/configure/actions.py,sha256=3rrWHaCAsogyx0Ll-lcjbSzldD4kPuz1z6VQiWebSWw,3203
 qbraid_cli/configure/app.py,sha256=1uRe2lkUA4TtYb5b4mbD4LH-cKCbsZGT3Wfk7fpNzX0,2414
 qbraid_cli/credits/__init__.py,sha256=t-3XAJFAXiu_jI4sgjaIOuNne_AoSYaSEsi-SSRkvPw,154
-qbraid_cli/credits/app.py,sha256=iHikmjx8pylMFNzHckuauOg-Nb9pS7xQq_H75ibVJig,774
+qbraid_cli/credits/app.py,sha256=AY3qtveO50KeQ2XREiEVqUcTrESgRuoqt9pt2Z8t4Y0,866
 qbraid_cli/devices/__init__.py,sha256=_PU3eMQRV4DkPw-oCmfCPh8EbVmgG76ieEKuNsY9Xqc,154
 qbraid_cli/devices/app.py,sha256=zxSxrEQn7irkJoME4S_CBnRqWeB8cqPaBsIMfpdYFk0,2530
 qbraid_cli/devices/validation.py,sha256=YhShyUufgrKnx2XjXOXF-PqFJYklJT9CgeqIwKcNam4,809
@@ -26,8 +26,8 @@ qbraid_cli/jobs/toggle_braket.py,sha256=d5C_Di80jWMFlh-77eH8YY9pjMKWXK5abenUDtPl
 qbraid_cli/jobs/validation.py,sha256=xNbjUggMhUs4wzkuRm4PuFPi_wrElYicUgYXLznHz3U,2983
 qbraid_cli/kernels/__init__.py,sha256=VhpBota_v7OoiGxrPCqJU4XBVcolf81mbCYGSxXzVhc,154
 qbraid_cli/kernels/app.py,sha256=ZJWVdKzCDfzGnA1pqp01vDbE7fh8p84jC-y6DDgWlxc,3373
-qbraid_cli-0.8.0.dev7.dist-info/METADATA,sha256=2TTf3_aT_Dt7MxkpSCUgwXlKiFfA2UzWWCpieAL8u_c,5919
-qbraid_cli-0.8.0.dev7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-qbraid_cli-0.8.0.dev7.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
-qbraid_cli-0.8.0.dev7.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
-qbraid_cli-0.8.0.dev7.dist-info/RECORD,,
+qbraid_cli-0.8.1a0.dist-info/METADATA,sha256=KVpOOlMih6hukKoS6rXu6ybRv0oN9NWsU2zb5ilxJHE,7170
+qbraid_cli-0.8.1a0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qbraid_cli-0.8.1a0.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.8.1a0.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.8.1a0.dist-info/RECORD,,