qbraid-cli 0.9.0a0__py3-none-any.whl → 0.9.1__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.9.0a0'
-__version_tuple__ = version_tuple = (0, 9, 0)
+__version__ = version = '0.9.1'
+__version_tuple__ = version_tuple = (0, 9, 1)

qbraid_cli/account/app.py

@@ -28,7 +28,7 @@ def account_credits():
 
     qbraid_credits: float = run_progress_task(get_credits)
     typer.secho(
-        f"\n{typer.style('qBraid credits remaining:')} "
+        f"{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)
     )

qbraid_cli/chat/__init__.py

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

qbraid_cli/chat/app.py

@@ -0,0 +1,96 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid chat' namespace.
+
+"""
+from enum import Enum
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from qbraid_cli.handlers import handle_error, run_progress_task
+
+chat_app = typer.Typer(
+    help="Interact with qBraid AI chat service.", pretty_exceptions_show_locals=False
+)
+
+
+class ChatFormat(str, Enum):
+    """Format of the response from the chat service."""
+
+    text = "text"  # pylint: disable=invalid-name
+    code = "code"  # pylint: disable=invalid-name
+
+
+@chat_app.command("send")
+def chat_send(
+    prompt: str = typer.Argument(..., help="The prompt to send to the chat service."),
+    model: str = typer.Option(None, "--model", "-m", help="The model to use for the chat service."),
+    response_format: ChatFormat = typer.Option(
+        ChatFormat.text, "--format", "-f", help="The format of the response."
+    ),
+    stream: bool = typer.Option(False, "--stream", "-s", help="Stream the response."),
+):
+    """
+    Interact with qBraid AI chat service.
+
+    """
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.chat import ChatClient, ChatServiceRequestError
+
+    client = ChatClient()
+
+    if response_format == ChatFormat.code:
+        prompt += " Return only raw code. Do not include any text outside of code blocks."
+
+    if stream:
+        try:
+            for chunk in client.chat_stream(prompt, model, response_format):
+                print(chunk, end="")
+        except ChatServiceRequestError as err:
+            handle_error(message=str(err), include_traceback=False)
+    else:
+        content = run_progress_task(
+            client.chat,
+            prompt,
+            model,
+            response_format,
+            description="Connecting to chat service...",
+            include_error_traceback=False,
+        )
+        print(content)
+
+
+@chat_app.command(name="models")
+def chat_models():
+    """List available chat models."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.chat import ChatClient
+
+    client = ChatClient()
+
+    models = run_progress_task(
+        client.get_models,
+        description="Connecting to chat service...",
+        include_error_traceback=False,
+    )
+
+    console = Console()
+    table = Table(title="Available Chat Models\n", show_lines=True, title_justify="left")
+
+    table.add_column("Model", style="cyan", no_wrap=True)
+    table.add_column("Pricing [not bold](1k tokens ~750 words)", style="magenta")
+    table.add_column("Description", style="green")
+
+    for model in models:
+        table.add_row(
+            model["model"],
+            f"{model['pricing']['input']} credits / 1M input tokens\n"
+            f"{model['pricing']['output']} credits / 1M output tokens",
+            model["description"],
+        )
+
+    console.print(table)

qbraid_cli/devices/app.py

@@ -60,7 +60,7 @@ def devices_list(  # pylint: disable=too-many-branches
     header_3 = "ID"
     header_4 = "Status"
     console.print(
-        f"\n[bold]{header_1.ljust(12)}{header_2.ljust(35)}{header_3.ljust(41)}{header_4}[/bold]"
+        f"[bold]{header_1.ljust(12)}{header_2.ljust(35)}{header_3.ljust(41)}{header_4}[/bold]"
     )
     for device_provider, device_name, device_id, device_status in device_data:
         if device_status == "ONLINE":

qbraid_cli/envs/app.py

@@ -88,7 +88,7 @@ def envs_create(  # pylint: disable=too-many-statements
     slug_path = env_path / slug
     description = "None" if description == "" else description
 
-    typer.echo("\n\n## qBraid Metadata ##\n")
+    typer.echo("## qBraid Metadata ##\n")
     typer.echo(f"  name: {display_name}")
     typer.echo(f"  description: {description}")
     typer.echo(f"  tags: {tags}")
@@ -127,7 +127,7 @@ def envs_create(  # pylint: disable=too-many-statements
 
     console = Console()
     console.print(
-        f"\n[bold green]Successfully created qBraid environment: "
+        f"[bold green]Successfully created qBraid environment: "
         f"[/bold green][bold magenta]{name}[/bold magenta]\n"
     )
     typer.echo("# To activate this environment, use")
@@ -192,7 +192,7 @@ def envs_remove(
             description="Deleting local environment...",
             error_message="Failed to delete qBraid environment",
         )
-        typer.echo(f"\nEnvironment '{name}' successfully removed.")
+        typer.echo(f"Environment '{name}' successfully removed.")
 
 
 @envs_app.command(name="list")

qbraid_cli/handlers.py

@@ -10,11 +10,12 @@ and executing operations with progress tracking within the qBraid CLI.
 import os
 import traceback
 from pathlib import Path
+from time import sleep
 from typing import Any, Callable, Optional, Union
 
 import typer
 from rich.console import Console
-from rich.progress import Progress, SpinnerColumn, TextColumn
+from rich.progress import Progress, SpinnerColumn, TaskID, TextColumn
 
 from .exceptions import DEFAULT_ERROR_MESSAGE, QbraidException
 
@@ -24,6 +25,14 @@ def _should_display_progress():
     return os.getenv("QBRAID_CLI_SHOW_PROGRESS", "true").lower() in ["true", "1", "t", "y", "yes"]
 
 
+def _update_completed_task(
+    progress: Progress, task_id: TaskID, success: bool = True, sleep_time: float = 0.15
+):
+    status = "Done" if success else "Failed"
+    progress.update(task_id, completed=100, status=status)
+    sleep(sleep_time)
+
+
 def handle_error(
     error_type: Optional[str] = None, message: Optional[str] = None, include_traceback: bool = True
 ) -> None:
@@ -85,6 +94,7 @@ def run_progress_task(
     *args,
     description: Optional[str] = None,
     error_message: Optional[str] = None,
+    include_error_traceback: bool = True,
     **kwargs,
 ) -> Any:
     """
@@ -102,6 +112,8 @@ def run_progress_task(
         error_message (optional, str): Custom error message to display if the operation.
                                        fails. Defaults to None, in which case the
                                        exception's message is used.
+        include_error_traceback (bool): Whether to include the traceback in the error message.
+                                        Defaults to True.
         **kwargs: Arbitrary keyword arguments for the operation.
 
     Returns:
@@ -115,7 +127,7 @@ def run_progress_task(
             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)
+            return handle_error(message=custom_message, include_traceback=include_error_traceback)
 
     console = Console()
     with Progress(
@@ -128,12 +140,14 @@ def run_progress_task(
         task = progress.add_task(description, status="In Progress", total=None)
         try:
             result = operation(*args, **kwargs)
-            progress.update(task, completed=100, status="Done")
+            _update_completed_task(progress, task, success=True)
             return result
         except Exception as err:  # pylint: disable=broad-exception-caught
-            progress.update(task, completed=100, status="Failed")
+            _update_completed_task(progress, task, success=False)
             custom_message = error_message if error_message else str(err)
-            return handle_error(message=custom_message)
+            return handle_error(message=custom_message, include_traceback=include_error_traceback)
+        finally:
+            progress.remove_task(task)
 
 
 def _format_list_items(items: list[str]) -> str:

qbraid_cli/jobs/app.py

@@ -120,7 +120,7 @@ def jobs_list(
         header_1 = "Job ID"
         header_2 = "Submitted"
         header_3 = "Status"
-        console.print(f"\n[bold]{header_1.ljust(spacing)}{header_2.ljust(36)}{header_3}[/bold]")
+        console.print(f"[bold]{header_1.ljust(spacing)}{header_2.ljust(36)}{header_3}[/bold]")
         for job_id, submitted, status in job_data:
             if status == "COMPLETED":
                 status_color = "green"

qbraid_cli/jobs/toggle_braket.py

@@ -103,7 +103,7 @@ def confirm_updates(
     else:
         raise ValueError(f"Invalid mode: {mode}. Expected 'enable' or 'disable'.")
 
-    typer.echo(f"\n==> WARNING: {provider}/{core_package} package required <==")
+    typer.echo(f"==> WARNING: {provider}/{core_package} package required <==")
     if (
         installed_version is not None
         and target_version is not None

qbraid_cli/main.py

@@ -6,10 +6,12 @@ Entrypoint for the qBraid CLI.
 
 """
 
+import rich
 import typer
 
 from qbraid_cli.account.app import account_app
 from qbraid_cli.admin.app import admin_app
+from qbraid_cli.chat.app import chat_app
 from qbraid_cli.configure.app import configure_app
 from qbraid_cli.devices.app import devices_app
 from qbraid_cli.jobs.app import jobs_app
@@ -26,6 +28,7 @@ except ImportError:
 app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
 
 app.add_typer(admin_app, name="admin")
+app.add_typer(chat_app, name="chat")
 app.add_typer(configure_app, name="configure")
 app.add_typer(account_app, name="account")
 app.add_typer(devices_app, name="devices")
@@ -67,7 +70,7 @@ def show_banner():
     typer.echo("")
     typer.echo("- Use 'qbraid --version' to see the current version.")
     typer.echo("")
-    typer.echo("Reference Docs: https://docs.qbraid.com/cli/api-reference/qbraid")
+    rich.print("Reference Docs: https://docs.qbraid.com/cli/api-reference/qbraid")
 
 
 @app.callback(invoke_without_command=True)

{qbraid_cli-0.9.0a0.dist-info → qbraid_cli-0.9.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.0a0
+Version: 0.9.1
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,16 +29,16 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: qbraid-core>=0.1.28
+Requires-Dist: qbraid-core>=0.1.30
+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: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Provides-Extra: envs
-Requires-Dist: qbraid-core[environments]; extra == "envs"
-Provides-Extra: jobs
-Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 
 <img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
 

{qbraid_cli-0.9.0a0.dist-info → qbraid_cli-0.9.1.dist-info}/RECORD

@@ -1,38 +1,40 @@
 qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qbraid_cli/_version.py,sha256=HjY1UzcNtKKrJ8GVdemZ4PKAbhmYJUmCc4zQTJY4W0I,413
+qbraid_cli/_version.py,sha256=_P6tBRUyis5e8UBMut-5M8NVccs2HwAQXTxErAP99SI,411
 qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
-qbraid_cli/handlers.py,sha256=3RTG5FHL5GTyDoBUv81x5sLyqwf8nzkcqBi0k1ayoW8,7034
-qbraid_cli/main.py,sha256=wjfPLM4FKmvk4Y3xQ7wW12RmRKy9kMIkdVtRlw6Nrbg,2749
+qbraid_cli/handlers.py,sha256=B9H1Qw6yx8izrqp9OGR2TgSJa_mxA8KLXUkX8LB7Feg,7650
+qbraid_cli/main.py,sha256=Xhqbkfi9MtxulrIbEDnBK_gpfHluBGa5YluCIkJuoLg,2839
 qbraid_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 qbraid_cli/account/__init__.py,sha256=smlpUcVkM3QEbJG0norGM7i71XBJlUGQYByswTfPnmg,181
-qbraid_cli/account/app.py,sha256=-dVlAdGG0xKvjzk9248p3EcHnvKamVSmiZBW_xCMGII,1823
+qbraid_cli/account/app.py,sha256=ggvft1Q4d5IIv0lf3adbIkcz0nIYiEriJu91SPyo5_4,1821
 qbraid_cli/admin/__init__.py,sha256=qcWD5mQEUCtr49mrUpZmk7eGDe0L_Gtc8RwZmzIXSwo,175
 qbraid_cli/admin/app.py,sha256=NGisg2aouk8qK2oFogwblFTBK0vvTiL_zJYjeanC4x0,1576
 qbraid_cli/admin/headers.py,sha256=WqpRYp81CQcF5-Afumo_qQrf-5XCfbndBJ6I7vOADKE,7133
 qbraid_cli/admin/validation.py,sha256=U_8RFWBwRUNPe6LdjNpl-Yz8Br57PLWMoPbpR-jBS-M,979
+qbraid_cli/chat/__init__.py,sha256=0He19OpSsEoyCGxZLMTWey1fKAAls5mHTCFlO5-gl2Y,172
+qbraid_cli/chat/app.py,sha256=QQqwCi3dk-_i5XTe8labQFPN5xttFKoLf7oWIrhlmyQ,2913
 qbraid_cli/configure/__init__.py,sha256=YaJ74Ztz2vl3eYp8_jVBucWkXscxz7EZEIzr70OfuOM,187
 qbraid_cli/configure/actions.py,sha256=-BduRmnxvf8JMNonb6VWFtdlHlcHPOPz3Bj5g8kfmBU,3197
 qbraid_cli/configure/app.py,sha256=1uRe2lkUA4TtYb5b4mbD4LH-cKCbsZGT3Wfk7fpNzX0,2414
 qbraid_cli/devices/__init__.py,sha256=hiScO-px6jCL5cJj5Hbty55EUfNejTO4bmqUZuS3aqc,181
-qbraid_cli/devices/app.py,sha256=3Ly5PPNVhipzbX2h3FrB3fWawLbUcQFcUqv_cZv5eYk,2523
+qbraid_cli/devices/app.py,sha256=K5NBtXgwncn8x0lzZlXuagb_jWCKXBBdhFMm96eDJBM,2521
 qbraid_cli/devices/validation.py,sha256=YhShyUufgrKnx2XjXOXF-PqFJYklJT9CgeqIwKcNam4,809
 qbraid_cli/envs/__init__.py,sha256=1-cMvrATsddYxcetPJWxq6bEOqJWMktGdhoZ4qm8euA,172
 qbraid_cli/envs/activate.py,sha256=VpvVYSfQDlcmlNWJOgkLIQ2p8YXPPLG8Jbl5t8GHUDw,2140
-qbraid_cli/envs/app.py,sha256=5bb6OQUgcyCPw0REqEyjFHrjqsuhEn8zCsI3d6abgpI,8455
+qbraid_cli/envs/app.py,sha256=2iJ0Ik39zf_5Kj0hCvkykAdU8ESdUoLodw1-tpcKXyE,8447
 qbraid_cli/envs/create.py,sha256=xudzkLCNegY34zkXN_Vfl_0zVzg_tW83LcVx9quoWfU,988
 qbraid_cli/envs/data_handling.py,sha256=Ibnp2yJoUDpivb_sNqi0suYgJZNat_LmM6Ya0Ovez5s,1288
 qbraid_cli/jobs/__init__.py,sha256=qVLRHYIzP4XHpx_QWP_vCzd3LsCscCORaEx-Vcbx29U,172
-qbraid_cli/jobs/app.py,sha256=veyY5aunlPaDYCVmAHmEtaIo_veUVWRXmCB_GBJHEuQ,4918
-qbraid_cli/jobs/toggle_braket.py,sha256=lQOG6h39vG3JsRh90LuJ8g_3hNuMSq8jdpRjjBG6SyQ,7446
+qbraid_cli/jobs/app.py,sha256=x4mF8KfP9FWyYKZLG5MkkHFQErgYO4VoYEQbtq7q_-Q,4916
+qbraid_cli/jobs/toggle_braket.py,sha256=3AEu-Z5q4avduB-fJMyMTVTuyZXuA8m-hnvi325wIv4,7444
 qbraid_cli/jobs/validation.py,sha256=KlkqVH1-vlNCHSayEpxzyXU86_TMN5prGfMFEoyBsFs,2971
 qbraid_cli/kernels/__init__.py,sha256=jORS9vV17s5laQyq8gSVB18EPBImgEIbMZ1wKC094DA,181
 qbraid_cli/kernels/app.py,sha256=Sl57U1JXDKWoeMQDSXJRHlKzDYSdKIbV7tSytZXo5PM,2926
 qbraid_cli/pip/__init__.py,sha256=tJtU0rxn-ODogNh5Y4pp_BgDQXMN-3JY1QGj0OZHwjQ,169
 qbraid_cli/pip/app.py,sha256=wzvjX5NL37XIFtZ5KvTZ-nj9xwFKt8QLYZ_vGvk3tXo,1440
 qbraid_cli/pip/hooks.py,sha256=jkIeev3cOd-cmaoJSdSqbmhTYCs6z1we84FMqa3ZoZw,2124
-qbraid_cli-0.9.0a0.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
-qbraid_cli-0.9.0a0.dist-info/METADATA,sha256=YM5B8T3TY-xOKLffoclGkb89xsbrGUnB60T-b7ZSono,6787
-qbraid_cli-0.9.0a0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-qbraid_cli-0.9.0a0.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
-qbraid_cli-0.9.0a0.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
-qbraid_cli-0.9.0a0.dist-info/RECORD,,
+qbraid_cli-0.9.1.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
+qbraid_cli-0.9.1.dist-info/METADATA,sha256=L2lfHPXbMA5GIsg3b94GxeooGVA502ZsJknonMNJBg0,6785
+qbraid_cli-0.9.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+qbraid_cli-0.9.1.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.9.1.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.9.1.dist-info/RECORD,,

{qbraid_cli-0.9.0a0.dist-info → qbraid_cli-0.9.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any