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

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

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

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

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

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.9.1"
+version = "0.9.3"
 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,8 @@ classifiers = [
 dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
-    "qbraid-core>=0.1.30",
+    "click",
+    "qbraid-core>=0.1.32",
 ]
 requires-python = ">= 3.9"
 

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

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

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/account/app.py

@@ -13,7 +13,7 @@ import typer
 
 from qbraid_cli.handlers import run_progress_task
 
-account_app = typer.Typer(help="Manage qBraid account.")
+account_app = typer.Typer(help="Manage qBraid account.", no_args_is_help=True)
 
 
 @account_app.command(name="credits")

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/admin/app.py

@@ -14,7 +14,9 @@ from qbraid_cli.admin.headers import check_and_fix_headers
 from qbraid_cli.admin.validation import validate_header_type, validate_paths_exist
 
 admin_app = typer.Typer(
-    help="CI/CD commands for qBraid maintainers.", pretty_exceptions_show_locals=False
+    help="CI/CD commands for qBraid maintainers.",
+    pretty_exceptions_show_locals=False,
+    no_args_is_help=True,
 )
 
 

qbraid_cli-0.9.3/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 ChatFormat, list_models_callback, prompt_callback
+
+__all__ = ["list_models_callback", "prompt_callback", "ChatFormat"]

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/chat/app.py

@@ -7,16 +7,11 @@ 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."""
@@ -25,47 +20,7 @@ class ChatFormat(str, Enum):
     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():
+def list_models_callback():
     """List available chat models."""
     # pylint: disable-next=import-outside-toplevel
     from qbraid_core.services.chat import ChatClient
@@ -94,3 +49,28 @@ def chat_models():
         )
 
     console.print(table)
+
+
+def prompt_callback(prompt: str, model: str, response_format: ChatFormat, stream: bool):
+    """Send a chat prompt to the chat service."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.chat import ChatClient, ChatServiceRequestError
+
+    client = ChatClient()
+
+    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)

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/devices/app.py

@@ -14,7 +14,7 @@ from rich.console import Console
 from qbraid_cli.devices.validation import validate_provider, validate_status, validate_type
 from qbraid_cli.handlers import run_progress_task
 
-devices_app = typer.Typer(help="Manage qBraid quantum devices.")
+devices_app = typer.Typer(help="Manage qBraid quantum devices.", no_args_is_help=True)
 
 
 @devices_app.command(name="list")

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/envs/app.py

@@ -23,7 +23,7 @@ from qbraid_cli.handlers import QbraidException, run_progress_task
 if TYPE_CHECKING:
     from qbraid_core.services.environments.client import EnvironmentManagerClient as EMC
 
-envs_app = typer.Typer(help="Manage qBraid environments.")
+envs_app = typer.Typer(help="Manage qBraid environments.", no_args_is_help=True)
 
 
 @envs_app.command(name="create")

qbraid_cli-0.9.3/qbraid_cli/files/__init__.py

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

qbraid_cli-0.9.3/qbraid_cli/files/app.py

@@ -0,0 +1,118 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid files' namespace.
+
+"""
+
+from pathlib import Path
+from typing import Any
+
+import rich
+import typer
+
+from qbraid_cli.handlers import run_progress_task
+
+files_app = typer.Typer(help="Manage qBraid cloud storage files.", no_args_is_help=True)
+
+
+@files_app.command(name="upload")
+def files_upload(
+    filepath: Path = typer.Argument(
+        ...,
+        exists=True,
+        dir_okay=False,
+        resolve_path=True,
+        help="Local path to the file to upload.",
+    ),
+    namespace: str = typer.Option(
+        "user",
+        "--namespace",
+        "-n",
+        help="Target qBraid namespace for the upload.",
+    ),
+    object_path: str = typer.Option(
+        None,
+        "--object-path",
+        "-p",
+        help=("Target object path. " "Defaults to original filename in namespace root."),
+    ),
+    overwrite: bool = typer.Option(
+        False,
+        "--overwrite",
+        "-o",
+        help="Overwrite existing file if it already exists in the target location.",
+    ),
+):
+    """Upload a local file to qBraid storage."""
+
+    def upload_file() -> dict[str, Any]:
+        from qbraid_core.services.files import FileManagerClient
+
+        client = FileManagerClient()
+        data = client.upload_file(
+            filepath, namespace=namespace, object_path=object_path, overwrite=overwrite
+        )
+        return data
+
+    data: dict = run_progress_task(
+        upload_file, description="Uploading file...", include_error_traceback=False
+    )
+
+    rich.print("File uploaded successfully!")
+    namespace = data.get("namespace")
+    object_path = data.get("objectPath")
+
+    if namespace and object_path:
+        rich.print(f"\nNamespace: '{namespace}'")
+        rich.print(f"Object path: '{object_path}'")
+
+
+@files_app.command(name="download")
+def files_download(
+    object_path: str = typer.Argument(
+        ...,
+        help="The folder + filename describing the file to download.",
+    ),
+    namespace: str = typer.Option(
+        "user",
+        "--namespace",
+        "-n",
+        help="Source qBraid namespace for the download.",
+    ),
+    save_path: Path = typer.Option(
+        Path.cwd(),
+        "--save-path",
+        "-s",
+        resolve_path=True,
+        help="Local directory to save the downloaded file.",
+    ),
+    overwrite: bool = typer.Option(
+        False,
+        "--overwrite",
+        "-o",
+        help="Overwrite existing file if it already exists in the target location.",
+    ),
+):
+    """Download a file from qBraid storage."""
+
+    def download_file() -> Path:
+        from qbraid_core.services.files import FileManagerClient
+
+        client = FileManagerClient()
+        file_path = client.download_file(
+            object_path, namespace=namespace, save_path=save_path, overwrite=overwrite
+        )
+        return file_path
+
+    file_path: Path = run_progress_task(
+        download_file, description="Downloading file...", include_error_traceback=False
+    )
+
+    rich.print("File downloaded successfully!")
+    rich.print(f"Saved to: '{str(file_path)}'")
+
+
+if __name__ == "__main__":
+    files_app()

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/jobs/app.py

@@ -15,7 +15,7 @@ from qbraid_cli.handlers import handle_error, run_progress_task
 from qbraid_cli.jobs.toggle_braket import disable_braket, enable_braket
 from qbraid_cli.jobs.validation import handle_jobs_state, run_progress_get_state, validate_library
 
-jobs_app = typer.Typer(help="Manage qBraid quantum jobs.")
+jobs_app = typer.Typer(help="Manage qBraid quantum jobs.", no_args_is_help=True)
 
 
 @jobs_app.command(name="enable")

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/kernels/app.py

@@ -11,7 +11,7 @@ from rich.console import Console
 
 from qbraid_cli.handlers import handle_error
 
-kernels_app = typer.Typer(help="Manage qBraid kernels.")
+kernels_app = typer.Typer(help="Manage qBraid kernels.", no_args_is_help=True)
 
 
 @kernels_app.command(name="list")

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

@@ -6,20 +6,22 @@ Entrypoint for the qBraid CLI.
 
 """
 
+import click
 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
+from qbraid_cli.account import account_app
+from qbraid_cli.admin import admin_app
+from qbraid_cli.chat import ChatFormat, list_models_callback, prompt_callback
+from qbraid_cli.configure import configure_app
+from qbraid_cli.devices import devices_app
+from qbraid_cli.files import files_app
+from qbraid_cli.jobs import jobs_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
+    from qbraid_cli.envs import envs_app
+    from qbraid_cli.kernels import kernels_app
+    from qbraid_cli.pip import pip_app
 
     ENVS_COMMANDS = True
 except ImportError:
@@ -28,10 +30,10 @@ 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")
+app.add_typer(files_app, name="files")
 app.add_typer(jobs_app, name="jobs")
 
 if ENVS_COMMANDS is True:
@@ -90,5 +92,34 @@ def main(
         show_banner()
 
 
+@app.command(help="Interact with qBraid AI chat service.", no_args_is_help=True)
+def chat(
+    prompt: str = typer.Option(
+        None, "--prompt", "-p", 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."),
+    list_models: bool = typer.Option(
+        False, "--list-models", "-l", help="List available chat models."
+    ),
+):
+    """
+    Interact with qBraid AI chat service.
+
+    """
+    if list_models:
+        list_models_callback()
+    elif prompt:
+        prompt_callback(prompt, model, response_format, stream)
+    else:
+        raise click.UsageError(
+            "Invalid command. Please provide a prompt using --prompt "
+            "or use --list-models to view available models."
+        )
+
+
 if __name__ == "__main__":
     app()

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/qbraid_cli/pip/app.py

@@ -16,8 +16,7 @@ from qbraid_core.system.executables import get_active_python_path
 from qbraid_cli.handlers import handle_error
 from qbraid_cli.pip.hooks import get_env_cfg_path, safe_set_include_sys_packages
 
-# disable pretty_exceptions_show_locals to avoid printing sensative information in the traceback
-pip_app = typer.Typer(help="Run pip command in active qBraid environment.")
+pip_app = typer.Typer(help="Run pip command in active qBraid environment.", no_args_is_help=True)
 
 
 @pip_app.command(

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

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

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

@@ -58,6 +58,8 @@ qbraid_cli/envs/activate.py
 qbraid_cli/envs/app.py
 qbraid_cli/envs/create.py
 qbraid_cli/envs/data_handling.py
+qbraid_cli/files/__init__.py
+qbraid_cli/files/app.py
 qbraid_cli/jobs/__init__.py
 qbraid_cli/jobs/app.py
 qbraid_cli/jobs/toggle_braket.py
@@ -86,6 +88,8 @@ tests/envs/test_envs_activate_print_command.py
 tests/envs/test_envs_activate_pyenv.py
 tests/envs/test_envs_list.py
 tests/envs/test_envs_remove.py
+tests/files/__init__.py
+tests/files/test_files_commands.py
 tests/jobs/__init__.py
 tests/jobs/test_jobs_disable.py
 tests/jobs/test_jobs_enable.py

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

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

qbraid_cli-0.9.3/tests/files/test_files_commands.py

@@ -0,0 +1,109 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+# pylint: disable=redefined-outer-name
+
+"""
+Unit tests for the `qbraid_cli.files.app` module.
+
+"""
+
+from unittest.mock import patch
+
+import pytest
+from typer.testing import CliRunner
+
+from qbraid_cli.files.app import files_app
+
+
+@pytest.fixture
+def runner():
+    """Fixture for invoking CLI commands."""
+    return CliRunner()
+
+
+def test_files_upload(runner, tmp_path):
+    """Test the `files upload` command."""
+    test_file = tmp_path / "test_file.txt"
+    test_file.write_text("Test content")
+
+    with patch("qbraid_core.services.files.FileManagerClient") as mock_client:
+        mock_client.return_value.upload_file.return_value = {
+            "namespace": "user",
+            "objectPath": "test_file.txt",
+        }
+
+        result = runner.invoke(files_app, ["upload", str(test_file)])
+
+    assert result.exit_code == 0
+    assert "File uploaded successfully!" in result.stdout
+    assert "Namespace: 'user'" in result.stdout
+    assert "Object path: 'test_file.txt'" in result.stdout
+
+
+def test_files_upload_with_options(runner, tmp_path):
+    """Test the `files upload` command with options."""
+    test_file = tmp_path / "test_file.txt"
+    test_file.write_text("Test content")
+
+    with patch("qbraid_core.services.files.FileManagerClient") as mock_client:
+        mock_client.return_value.upload_file.return_value = {
+            "namespace": "custom",
+            "objectPath": "folder/test_file.txt",
+        }
+
+        result = runner.invoke(
+            files_app,
+            [
+                "upload",
+                str(test_file),
+                "--namespace",
+                "custom",
+                "--object-path",
+                "folder/test_file.txt",
+                "--overwrite",
+            ],
+        )
+
+    assert result.exit_code == 0
+    assert "File uploaded successfully!" in result.stdout
+    assert "Namespace: 'custom'" in result.stdout
+    assert "Object path: 'folder/test_file.txt'" in result.stdout
+
+
+def test_files_download(runner, tmp_path):
+    """Test the `files download` command."""
+    with patch("qbraid_core.services.files.FileManagerClient") as mock_client:
+        mock_client.return_value.download_file.return_value = tmp_path / "downloaded_file.txt"
+
+        result = runner.invoke(files_app, ["download", "test_file.txt"])
+
+    assert result.exit_code == 0
+    assert "File downloaded successfully!" in result.stdout
+    assert f"Saved to: '{(tmp_path / 'downloaded_file.txt')}'" in result.stdout.replace("\n", "")
+
+
+def test_files_download_with_options(runner, tmp_path):
+    """Test the `files download` command with options."""
+    save_path = tmp_path / "custom_folder"
+    save_path.mkdir()
+
+    with patch("qbraid_core.services.files.FileManagerClient") as mock_client:
+        mock_client.return_value.download_file.return_value = save_path / "downloaded_file.txt"
+
+        result = runner.invoke(
+            files_app,
+            [
+                "download",
+                "folder/test_file.txt",
+                "--namespace",
+                "custom",
+                "--save-path",
+                str(save_path),
+                "--overwrite",
+            ],
+        )
+
+    assert result.exit_code == 0
+    assert "File downloaded successfully!" in result.stdout
+    assert f"Saved to: '{(save_path / 'downloaded_file.txt')}'" in result.stdout.replace("\n", "")

{qbraid_cli-0.9.1 → qbraid_cli-0.9.3}/tools/split_md.py

@@ -137,6 +137,8 @@ def markdown_to_mdx(file_path: str) -> None:
             )
             continue
 
+        line = line.replace("'", "'")
+
         new_lines.append(line)
 
     # Construct the new file path with .mdx extension

qbraid_cli-0.9.1/qbraid_cli/chat/__init__.py

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