qbraid-cli 0.9.2__py3-none-any.whl → 0.9.4__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.2'
-__version_tuple__ = version_tuple = (0, 9, 2)
+__version__ = version = '0.9.4'
+__version_tuple__ = version_tuple = (0, 9, 4)

qbraid_cli/envs/app.py

@@ -13,12 +13,13 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Optional
 
 import typer
+from qbraid_core.services.environments.schema import EnvironmentConfig
 from rich.console import Console
 
 from qbraid_cli.envs.create import create_qbraid_env_assets, create_venv
 from qbraid_cli.envs.data_handling import get_envs_data as installed_envs_data
 from qbraid_cli.envs.data_handling import validate_env_name
-from qbraid_cli.handlers import QbraidException, run_progress_task
+from qbraid_cli.handlers import QbraidException, handle_error, run_progress_task
 
 if TYPE_CHECKING:
     from qbraid_core.services.environments.client import EnvironmentManagerClient as EMC
@@ -28,18 +29,51 @@ envs_app = typer.Typer(help="Manage qBraid environments.", no_args_is_help=True)
 
 @envs_app.command(name="create")
 def envs_create(  # pylint: disable=too-many-statements
-    name: str = typer.Option(
-        ..., "--name", "-n", help="Name of the environment to create", callback=validate_env_name
-    ),
+    name: str = typer.Option(None, "--name", "-n", help="Name of the environment to create"),
     description: Optional[str] = typer.Option(
         None, "--description", "-d", help="Short description of the environment"
     ),
+    file_path: str = typer.Option(
+        None, "--file", "-f", help="Path to a .yml file containing the environment details"
+    ),
     auto_confirm: bool = typer.Option(
         False, "--yes", "-y", help="Automatically answer 'yes' to all prompts"
     ),
 ) -> None:
     """Create a new qBraid environment."""
     env_description = description or ""
+    if name:
+        if not validate_env_name(name):
+            handle_error(
+                error_type="ValueError",
+                include_traceback=False,
+                message=f"Invalid environment name '{name}'. ",
+            )
+
+    env_details_in_cli = name is not None and env_description != ""
+    custom_env_data = None
+    if env_details_in_cli and file_path:
+        handle_error(
+            error_type="ArgumentConflictError",
+            include_traceback=False,
+            message="Cannot use --file with --name or --description while creating an environment",
+        )
+    elif not env_details_in_cli and not file_path:
+        handle_error(
+            error_type="MalformedCommandError",
+            include_traceback=False,
+            message="Must provide either --name and --description or --file "
+            "while creating an environment",
+        )
+    else:
+        try:
+            if file_path:
+                custom_env_data: EnvironmentConfig = EnvironmentConfig.from_yaml(file_path)
+        except ValueError as err:
+            handle_error(error_type="YamlValidationError", message=str(err))
+
+    if not name:
+        name = custom_env_data.name
 
     def create_environment(*args, **kwargs) -> "tuple[dict, EMC]":
         """Create a qBraid environment."""
@@ -65,10 +99,15 @@ def envs_create(  # pylint: disable=too-many-statements
 
         return env_path, python_version
 
+    if not custom_env_data:
+        custom_env_data = EnvironmentConfig(
+            name=name,
+            description=env_description,
+        )
+
     environment, emc = run_progress_task(
         create_environment,
-        name,
-        env_description,
+        custom_env_data,
         description="Validating request...",
         error_message="Failed to create qBraid environment",
     )
@@ -78,6 +117,7 @@ def envs_create(  # pylint: disable=too-many-statements
         description="Solving environment...",
         error_message="Failed to create qBraid environment",
     )
+
     slug = environment.get("slug")
     display_name = environment.get("displayName")
     prompt = environment.get("prompt")

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/main.py

@@ -15,6 +15,7 @@ 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:
@@ -32,6 +33,7 @@ app.add_typer(admin_app, name="admin")
 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:

{qbraid_cli-0.9.2.dist-info → qbraid_cli-0.9.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.2
+Version: 0.9.4
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -30,7 +30,7 @@ License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: click
-Requires-Dist: qbraid-core>=0.1.31
+Requires-Dist: qbraid-core>=0.1.33
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: envs

{qbraid_cli-0.9.2.dist-info → qbraid_cli-0.9.4.dist-info}/RECORD

@@ -1,8 +1,8 @@
 qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qbraid_cli/_version.py,sha256=lsaP29l0rO1T9Xc-NzqRI1unCHF-S6aj-D4q3Uro4ko,411
+qbraid_cli/_version.py,sha256=N2r6Pxbr0xZx1XwnfGZ1tTgnRDaJpNzOV5NmOdJYA4A,411
 qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
 qbraid_cli/handlers.py,sha256=B9H1Qw6yx8izrqp9OGR2TgSJa_mxA8KLXUkX8LB7Feg,7650
-qbraid_cli/main.py,sha256=KuAd9mV__YVgCTFxtPpi3I6FgTH5Bi7f-DQfw0OnAK4,3848
+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=1UogauwgX0Hnr7H6cBV2Qv-lT6aRpRLAimCyLi0afGI,1843
@@ -20,9 +20,11 @@ qbraid_cli/devices/app.py,sha256=q8AQ8o05JXODsaFR_16_S3UtLWPzwC2qi0bVw2h7RJ8,254
 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=ug1myjrtYY0ukeT0mCJBFiRmnWqaWJCY-wclHS9TvMc,8469
+qbraid_cli/envs/app.py,sha256=c3O5fB6PThCXS2hyYMHrj8YvvEJaI-_8NZd_GN_4iZ0,9972
 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=LnrxALu7OWSUg1FD6FvlGsILdoH46Y-ra12eiSfiMlE,4938
 qbraid_cli/jobs/toggle_braket.py,sha256=3AEu-Z5q4avduB-fJMyMTVTuyZXuA8m-hnvi325wIv4,7444
@@ -32,9 +34,9 @@ qbraid_cli/kernels/app.py,sha256=n-iyWJHy7_ML6qk4pp-v_rQkGA7WfnZMG8gyiCFGO1c,294
 qbraid_cli/pip/__init__.py,sha256=tJtU0rxn-ODogNh5Y4pp_BgDQXMN-3JY1QGj0OZHwjQ,169
 qbraid_cli/pip/app.py,sha256=jkk-djductrDOJIRYfHK_7WDJ12f0zOT3MMkiZp97oM,1365
 qbraid_cli/pip/hooks.py,sha256=jkIeev3cOd-cmaoJSdSqbmhTYCs6z1we84FMqa3ZoZw,2124
-qbraid_cli-0.9.2.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
-qbraid_cli-0.9.2.dist-info/METADATA,sha256=EfE8B2mxvu7KwS2pad3et5r_NVi1qyOM59HeK93uN1k,6806
-qbraid_cli-0.9.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-qbraid_cli-0.9.2.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
-qbraid_cli-0.9.2.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
-qbraid_cli-0.9.2.dist-info/RECORD,,
+qbraid_cli-0.9.4.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
+qbraid_cli-0.9.4.dist-info/METADATA,sha256=fi9PnYYH7xpt09ko6-ejSpC_pdw4b6NsIj6LNcT8tEE,6806
+qbraid_cli-0.9.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+qbraid_cli-0.9.4.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.9.4.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.9.4.dist-info/RECORD,,