qbraid-cli 0.9.0__tar.gz → 0.9.1__tar.gz

{qbraid_cli-0.9.0 → qbraid_cli-0.9.1}/.readthedocs.yml

@@ -13,7 +13,7 @@ build:
     - python -m pip install -r docs/requirements.txt
     - python -m pip install build
     - python -m build .
-    - python -m pip install dist/*.whl
+    - tools/install_wheel_extras.sh dist --extra envs
     - 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.9.0/qbraid_cli.egg-info → qbraid_cli-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.0
+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,7 +29,7 @@ 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.29
+Requires-Dist: qbraid-core>=0.1.30
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: envs

{qbraid_cli-0.9.0 → qbraid_cli-0.9.1}/docs/index.rst

@@ -120,4 +120,5 @@ by disabling quantum jobs:
    tree/qbraid_envs
    tree/qbraid_jobs
    tree/qbraid_kernels
-   tree/qbraid_pip
+   tree/qbraid_pip
+   tree/qbraid_chat

{qbraid_cli-0.9.0 → qbraid_cli-0.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.9.0"
+version = "0.9.1"
 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>=0.1.29",
+    "qbraid-core>=0.1.30",
 ]
 requires-python = ">= 3.9"
 

{qbraid_cli-0.9.0 → qbraid_cli-0.9.1}/qbraid_cli/_version.py

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

qbraid_cli-0.9.1/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-0.9.1/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-0.9.0 → qbraid_cli-0.9.1}/qbraid_cli/handlers.py

@@ -15,7 +15,7 @@ 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
 
@@ -25,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:
@@ -86,6 +94,7 @@ def run_progress_task(
     *args,
     description: Optional[str] = None,
     error_message: Optional[str] = None,
+    include_error_traceback: bool = True,
     **kwargs,
 ) -> Any:
     """
@@ -103,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:
@@ -116,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(
@@ -129,13 +140,12 @@ 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")
-            sleep(0.15)
+            _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)
 

{qbraid_cli-0.9.0 → qbraid_cli-0.9.1}/qbraid_cli/main.py

@@ -11,6 +11,7 @@ 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
@@ -27,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")

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.0
+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,7 +29,7 @@ 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.29
+Requires-Dist: qbraid-core>=0.1.30
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: envs

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

@@ -45,6 +45,8 @@ qbraid_cli/admin/__init__.py
 qbraid_cli/admin/app.py
 qbraid_cli/admin/headers.py
 qbraid_cli/admin/validation.py
+qbraid_cli/chat/__init__.py
+qbraid_cli/chat/app.py
 qbraid_cli/configure/__init__.py
 qbraid_cli/configure/actions.py
 qbraid_cli/configure/app.py

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

@@ -1,6 +1,6 @@
 typer>=0.12.1
 rich>=10.11.0
-qbraid-core>=0.1.29
+qbraid-core>=0.1.30
 
 [dev]
 isort