qbraid-cli 0.9.2__tar.gz → 0.9.4__tar.gz

{qbraid_cli-0.9.2/qbraid_cli.egg-info → qbraid_cli-0.9.4}/PKG-INFO

@@ -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 → qbraid_cli-0.9.4}/docs/index.rst

@@ -6,7 +6,7 @@ Documentation
    <br />
    
    <h1 style="text-align: center">
-      <img src="../_static/logo.png" alt="qbraid logo" style="width:50px;height:50px;">
+      <img src="_static/logo.png" alt="qbraid logo" style="width:50px;height:50px;">
       <span> qBraid</span>
       <span style="color:#808080"> | CLI</span>
    </h1>
@@ -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.2 → qbraid_cli-0.9.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.9.2"
+version = "0.9.4"
 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" }]
@@ -31,7 +31,7 @@ dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
     "click",
-    "qbraid-core>=0.1.31",
+    "qbraid-core>=0.1.33",
 ]
 requires-python = ">= 3.9"
 

{qbraid_cli-0.9.2 → qbraid_cli-0.9.4}/qbraid_cli/_version.py

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

{qbraid_cli-0.9.2 → qbraid_cli-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-0.9.4/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.4/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.2 → qbraid_cli-0.9.4}/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 → qbraid_cli-0.9.4/qbraid_cli.egg-info}/PKG-INFO

@@ -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 → qbraid_cli-0.9.4}/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
@@ -84,8 +86,11 @@ tests/envs/test_envs_activate.py
 tests/envs/test_envs_activate_find_shell_rc.py
 tests/envs/test_envs_activate_print_command.py
 tests/envs/test_envs_activate_pyenv.py
+tests/envs/test_envs_create_from_yaml.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
@@ -100,6 +105,9 @@ tests/jobs/test_jobs_validate_handle_state.py
 tests/jobs/test_jobs_validate_library.py
 tests/kernels/__init__.py
 tests/kernels/test_kernels_list.py
+tests/resources/envs/correct.yaml
+tests/resources/envs/icon.png
+tests/resources/envs/incorrect.yaml
 tools/bump_version.py
 tools/create_dev_build.sh
 tools/install_wheel_extras.sh

{qbraid_cli-0.9.2 → qbraid_cli-0.9.4}/qbraid_cli.egg-info/requires.txt

@@ -1,7 +1,7 @@
 typer>=0.12.1
 rich>=10.11.0
 click
-qbraid-core>=0.1.31
+qbraid-core>=0.1.33
 
 [dev]
 isort

qbraid_cli-0.9.4/tests/envs/test_envs_create_from_yaml.py

@@ -0,0 +1,108 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Unit tests for the `qbraid_cli.envs.app` module's `activate` command.
+
+"""
+from pathlib import Path
+from unittest.mock import patch
+
+from typer.testing import CliRunner
+
+from qbraid_cli.envs.app import envs_app
+
+runner = CliRunner(mix_stderr=False)
+
+MOCK_API_RETURN_OBJ = {
+    "description": "This is a test qBraid environment for demonstration purposes.",
+    "logo": "test_s3_url",
+    "slug": "test_env_slug",
+    "displayName": "test_env",
+    "kernelName": "sample_kernel",
+    "name": "test_env",
+    "packagesInImage": {"numpy>=1.21.1", "openqasm3~=0.5.0", "qiskit", "cirq==1.0.0"},
+    "prompt": "sample_prompt",
+    "tags": ["test", "qbraid", "environment"],
+}
+
+
+def test_invalid_name_raises_error():
+    """Test that an invalid name raises an error."""
+    result = runner.invoke(
+        envs_app,
+        ["create", "--name", "invalid large name for environment", "--description", "test"],
+    )
+    assert result.exit_code == 2
+    assert "Invalid environment name " in result.stderr
+
+
+# we mock the usage path of the method NOT its definition path
+@patch("qbraid_cli.envs.app.run_progress_task")
+def test_correct_yaml_parse(mock_run_progress_task):
+    """Test that the correct YAML file is parsed correctly."""
+
+    mock_run_progress_task.side_effect = [
+        (MOCK_API_RETURN_OBJ, None),
+        (Path("path/to/test_env"), "3.8"),
+        None,
+        None,
+    ]
+    yaml_file = "resources/envs/correct.yaml"
+    file_path = Path(__file__).resolve().parent.parent / yaml_file
+    result = runner.invoke(envs_app, ["create", "--file", file_path])
+    assert result.exit_code == 0
+    expected_outputs = [
+        "Successfully created qBraid environment: test_env",
+        "name: test_env",
+        "description: This is a test qBraid environment for demonstration purposes.",
+        "tags: ['test', 'qbraid', 'environment']",
+        "slug: test_env_slug",
+        "shellPrompt: sample_prompt",
+        "kernelName: sample_kernel",
+        f"location: {Path('path/to/test_env/test_env_slug')}",
+        "version: 3.8",
+    ]
+    for output in expected_outputs:
+        assert output in result.stdout
+
+
+def test_invalid_yaml_file_raises_error():
+    """Test that an invalid YAML file raises an error."""
+    yaml_file = "resources/envs/incorrect.yaml"
+    file_path = Path(__file__).resolve().parent.parent / yaml_file
+    result = runner.invoke(envs_app, ["create", "--file", file_path])
+
+    assert result.exit_code == 1
+    assert "Invalid YAML data" in result.stderr
+
+
+def test_no_name_no_file_raises_error():
+    """Test that providing neither a name nor a file raises an error."""
+    result = runner.invoke(envs_app, ["create"])
+    assert result.exit_code == 1
+    assert (
+        "Must provide either --name and --description or --file while creating an environment"
+        in result.stderr
+    )
+
+
+def test_name_with_file_raises_error():
+    """Test that providing both a name and a file raises an error."""
+    result = runner.invoke(
+        envs_app,
+        [
+            "create",
+            "--name",
+            "test_env",
+            "--description",
+            "test",
+            "--file",
+            "resources/envs/correct.yaml",
+        ],
+    )
+    assert result.exit_code == 1
+    assert (
+        "Cannot use --file with --name or --description while creating an environment"
+        in result.stderr
+    )

qbraid_cli-0.9.4/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.4/tests/resources/envs/correct.yaml

@@ -0,0 +1,16 @@
+# Sample qBraid environment configuration
+name: "test_env"
+description: "This is a test qBraid environment for demonstration purposes."
+tags:
+  - "test"
+  - "qbraid"
+  - "environment"
+icon: "tests/resources/envs/icon.png"
+python_version: "3.8"
+kernel_name: "sample_kernel"
+shell_prompt: "sample_prompt"
+python_packages:
+  numpy: ">=1.21.0"
+  openqasm3: "~=0.5.0"
+  qiskit: ""
+  cirq: "1.0.0"

qbraid_cli-0.9.4/tests/resources/envs/incorrect.yaml

@@ -0,0 +1,4 @@
+# Sample qBraid environment configuration
+name: "test_env"
+description: "invalid"
+backend: "qiskit"

{qbraid_cli-0.9.2 → qbraid_cli-0.9.4}/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