qbraid-cli 0.9.1__py3-none-any.whl → 0.9.3__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.1'
-__version_tuple__ = version_tuple = (0, 9, 1)
+__version__ = version = '0.9.3'
+__version_tuple__ = version_tuple = (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/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/chat/__init__.py

@@ -6,6 +6,6 @@ Module defining the qbraid chat namespace
 
 """
 
-from .app import chat_app
+from .app import ChatFormat, list_models_callback, prompt_callback
 
-__all__ = ["chat_app"]
+__all__ = ["list_models_callback", "prompt_callback", "ChatFormat"]

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

@@ -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.dist-info → qbraid_cli-0.9.3.dist-info}/RECORD

@@ -1,40 +1,42 @@
 qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qbraid_cli/_version.py,sha256=_P6tBRUyis5e8UBMut-5M8NVccs2HwAQXTxErAP99SI,411
+qbraid_cli/_version.py,sha256=UKt4viYNHppvoM2VUu_oFmzU2bpc5MQ2Y0-6XGFMVuM,411
 qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
 qbraid_cli/handlers.py,sha256=B9H1Qw6yx8izrqp9OGR2TgSJa_mxA8KLXUkX8LB7Feg,7650
-qbraid_cli/main.py,sha256=Xhqbkfi9MtxulrIbEDnBK_gpfHluBGa5YluCIkJuoLg,2839
+qbraid_cli/main.py,sha256=aSOQyoRRvKBJBcx8VtU4zKZ2WHvGKHhw8I-WiRwPxcE,3926
 qbraid_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 qbraid_cli/account/__init__.py,sha256=smlpUcVkM3QEbJG0norGM7i71XBJlUGQYByswTfPnmg,181
-qbraid_cli/account/app.py,sha256=ggvft1Q4d5IIv0lf3adbIkcz0nIYiEriJu91SPyo5_4,1821
+qbraid_cli/account/app.py,sha256=1UogauwgX0Hnr7H6cBV2Qv-lT6aRpRLAimCyLi0afGI,1843
 qbraid_cli/admin/__init__.py,sha256=qcWD5mQEUCtr49mrUpZmk7eGDe0L_Gtc8RwZmzIXSwo,175
-qbraid_cli/admin/app.py,sha256=NGisg2aouk8qK2oFogwblFTBK0vvTiL_zJYjeanC4x0,1576
+qbraid_cli/admin/app.py,sha256=V2mgts3x3Vgsx_nbRwVrKF9PgZ9SuA10b8O9cjiphYE,1607
 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/chat/__init__.py,sha256=NO41vndEdfr0vDynNcmHFh-nhzWjnWqGm4M9parikck,258
+qbraid_cli/chat/app.py,sha256=-YqCLGDh4ezF149xB3dfuUAQotKAklZwYp0BL3HhA90,2256
 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=K5NBtXgwncn8x0lzZlXuagb_jWCKXBBdhFMm96eDJBM,2521
+qbraid_cli/devices/app.py,sha256=q8AQ8o05JXODsaFR_16_S3UtLWPzwC2qi0bVw2h7RJ8,2543
 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=2iJ0Ik39zf_5Kj0hCvkykAdU8ESdUoLodw1-tpcKXyE,8447
+qbraid_cli/envs/app.py,sha256=ug1myjrtYY0ukeT0mCJBFiRmnWqaWJCY-wclHS9TvMc,8469
 qbraid_cli/envs/create.py,sha256=xudzkLCNegY34zkXN_Vfl_0zVzg_tW83LcVx9quoWfU,988
 qbraid_cli/envs/data_handling.py,sha256=Ibnp2yJoUDpivb_sNqi0suYgJZNat_LmM6Ya0Ovez5s,1288
+qbraid_cli/files/__init__.py,sha256=3_yhgFoNcviEtS6B75uJBrfFFUjsrMcccCNEntJ54xU,175
+qbraid_cli/files/app.py,sha256=PoJAyfd1Y2OJm9wKNjbnzbouVOmOnrYeLWforOSFwgA,3182
 qbraid_cli/jobs/__init__.py,sha256=qVLRHYIzP4XHpx_QWP_vCzd3LsCscCORaEx-Vcbx29U,172
-qbraid_cli/jobs/app.py,sha256=x4mF8KfP9FWyYKZLG5MkkHFQErgYO4VoYEQbtq7q_-Q,4916
+qbraid_cli/jobs/app.py,sha256=LnrxALu7OWSUg1FD6FvlGsILdoH46Y-ra12eiSfiMlE,4938
 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/kernels/app.py,sha256=n-iyWJHy7_ML6qk4pp-v_rQkGA7WfnZMG8gyiCFGO1c,2948
 qbraid_cli/pip/__init__.py,sha256=tJtU0rxn-ODogNh5Y4pp_BgDQXMN-3JY1QGj0OZHwjQ,169
-qbraid_cli/pip/app.py,sha256=wzvjX5NL37XIFtZ5KvTZ-nj9xwFKt8QLYZ_vGvk3tXo,1440
+qbraid_cli/pip/app.py,sha256=jkk-djductrDOJIRYfHK_7WDJ12f0zOT3MMkiZp97oM,1365
 qbraid_cli/pip/hooks.py,sha256=jkIeev3cOd-cmaoJSdSqbmhTYCs6z1we84FMqa3ZoZw,2124
-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.3.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
+qbraid_cli-0.9.3.dist-info/METADATA,sha256=lL-5ZjFW1IHdCRUtXmJoAxxlsf8vNSoLboFmMAfwErc,6806
+qbraid_cli-0.9.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+qbraid_cli-0.9.3.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.9.3.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.9.3.dist-info/RECORD,,