qbraid-cli 0.8.0.dev0__py3-none-any.whl → 0.8.0.dev3__py3-none-any.whl

qbraid_cli/envs/app.py

@@ -1,85 +1,75 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
 """
 Module defining commands in the 'qbraid envs' namespace.
 
 """
 
-import json
 import shutil
+import subprocess
 import sys
 from pathlib import Path
-from typing import Dict, List, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple
 
 import typer
 from rich.console import Console
 
+from qbraid_cli.envs.data_handling import installed_envs_data, request_delete_env, validate_env_name
 from qbraid_cli.handlers import QbraidException, run_progress_task
 
-app = typer.Typer(help="Manage qBraid environments.")
-
-
-def installed_envs_data() -> Tuple[Dict[str, Path], Dict[str, str]]:
-    """Gather paths and aliases for all installed qBraid environments."""
-    from qbraid.api.system import get_qbraid_envs_paths, is_valid_slug
-
-    installed = {}
-    aliases = {}
-
-    qbraid_env_paths: List[Path] = get_qbraid_envs_paths()
-
-    for env_path in qbraid_env_paths:
-        for entry in env_path.iterdir():
-            if entry.is_dir() and is_valid_slug(entry.name):
-                installed[entry.name] = entry
-
-                if entry.name == "qbraid_000000":
-                    aliases["default"] = entry.name
-                    continue
+envs_app = typer.Typer(help="Manage qBraid environments.")
 
-                state_json_path = entry / "state.json"
-                if state_json_path.exists():
-                    try:
-                        with open(state_json_path, "r", encoding="utf-8") as f:
-                            data = json.load(f)
-                        aliases[data.get("name", entry.name[:-7])] = entry.name
-                    # pylint: disable-next=broad-exception-caught
-                    except (json.JSONDecodeError, Exception):
-                        aliases[entry.name[:-7]] = entry.name
-                else:
-                    aliases[entry.name[:-7]] = entry.name
 
-    return installed, aliases
-
-
-@app.command(name="create")
-def envs_create(
-    name: str = typer.Option(..., "--name", "-n", help="Name of the environment to create"),
+@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
+    ),
     description: Optional[str] = typer.Option(
         None, "--description", "-d", help="Short description of the environment"
     ),
+    auto_confirm: bool = typer.Option(
+        False, "--yes", "-y", help="Automatically answer 'yes' to all prompts"
+    ),
 ) -> None:
-    """Create a new qBraid environment.
-
-    NOTE: Requires updated API route from https://github.com/qBraid/api/pull/482,
-    This command will not work until that PR is merged, and the updates are deployed.
-    """
-    from .create import create_qbraid_env
+    """Create a new qBraid environment."""
+    from .create import create_qbraid_env_assets, create_venv
 
-    def request_new_env(req_body: Dict[str, str]) -> str:
+    def request_new_env(req_body: Dict[str, str]) -> Dict[str, Any]:
         """Send request to create new environment and return the slug."""
-        from qbraid.api import QbraidSession, RequestsApiError
+        from qbraid_core import QbraidSession, RequestsApiError
 
         session = QbraidSession()
 
         try:
-            resp = session.post("/environments/create", json=req_body).json()
+            env_data = session.post("/environments/create", json=req_body).json()
         except RequestsApiError as err:
             raise QbraidException("Create environment request failed") from err
 
-        slug = resp.get("slug")
-        if slug is None:
-            raise QbraidException(f"Create environment request returned invalid slug, {slug}")
+        if env_data is None or len(env_data) == 0 or env_data.get("slug") is None:
+            raise QbraidException(
+                "Create environment request responsed with invalid environment data"
+            )
 
-        return slug
+        return env_data
+
+    def gather_local_data() -> Tuple[Path, str]:
+        """Gather environment data and return the slug."""
+        from qbraid_core.services.environments import get_default_envs_paths
+
+        env_path = get_default_envs_paths()[0]
+
+        result = subprocess.run(
+            [sys.executable, "--version"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+
+        python_version = result.stdout or result.stderr
+
+        return env_path, python_version
 
     req_body = {
         "name": name,
@@ -89,92 +79,148 @@ def envs_create(
         "visibility": "private",
         "kernelName": "",
         "prompt": "",
+        "origin": "CLI",
     }
-    slug = run_progress_task(
+
+    environment = run_progress_task(
         request_new_env,
         req_body,
-        description="Validating...",
+        description="Validating request...",
         error_message="Failed to create qBraid environment",
     )
 
+    env_path, python_version = run_progress_task(
+        gather_local_data,
+        description="Solving environment...",
+        error_message="Failed to create qBraid environment",
+    )
+
+    slug = environment.get("slug")
+    display_name = environment.get("displayName")
+    prompt = environment.get("prompt")
+    description = environment.get("description")
+    tags = environment.get("tags")
+    kernel_name = environment.get("kernelName")
+
+    slug_path = env_path / slug
+    description = "None" if description == "" else description
+
+    typer.echo("\n\n## qBraid Metadata ##\n")
+    typer.echo(f"  name: {display_name}")
+    typer.echo(f"  description: {description}")
+    typer.echo(f"  tags: {tags}")
+    typer.echo(f"  slug: {slug}")
+    typer.echo(f"  shellPrompt: {prompt}")
+    typer.echo(f"  kernelName: {kernel_name}")
+
+    typer.echo("\n\n## Environment Plan ##\n")
+    typer.echo(f"  location: {slug_path}")
+    typer.echo(f"  version: {python_version}\n")
+
+    user_confirmation = auto_confirm or typer.confirm("Proceed", default=True)
+    typer.echo("")
+    if not user_confirmation:
+        request_delete_env(slug)
+        typer.echo("qBraidSystemExit: Exiting.")
+        raise typer.Exit()
+
     run_progress_task(
-        create_qbraid_env,
+        create_qbraid_env_assets,
         slug,
-        name,
-        description="Creating qBraid environment...",
+        prompt,
+        kernel_name,
+        slug_path,
+        description="Generating qBraid assets...",
+        error_message="Failed to create qBraid environment",
+    )
+
+    run_progress_task(
+        create_venv,
+        slug_path,
+        prompt,
+        description="Creating virtual environment...",
         error_message="Failed to create qBraid environment",
     )
 
-    # TODO: Add the command they can use to activate the environment to end of success message
     console = Console()
     console.print(
         f"\n[bold green]Successfully created qBraid environment: "
         f"[/bold green][bold magenta]{name}[/bold magenta]\n"
     )
+    typer.echo("# To activate this environment, use")
+    typer.echo("#")
+    typer.echo(f"#     $ qbraid envs activate {name}")
+    typer.echo("#")
+    typer.echo("# To deactivate an active environment, use")
+    typer.echo("#")
+    typer.echo("#     $ deactivate")
+
+
+@envs_app.command(name="remove")
+def envs_remove(
+    name: str = typer.Option(..., "-n", "--name", help="Name of the environment to remove"),
+    auto_confirm: bool = typer.Option(
+        False, "--yes", "-y", help="Automatically answer 'yes' to all prompts"
+    ),
+) -> None:
+    """Delete a qBraid environment."""
 
-
-@app.command(name="delete")
-def envs_delete(name: str = typer.Argument(..., help="Name of the environment to delete")) -> None:
-    """Delete a qBraid environment.
-
-    NOTE: Requires updated API route from https://github.com/qBraid/api/pull/482,
-    This command will not work until that PR is merged, and the updates are deployed.
-    """
-
-    def request_delete_env(name: str) -> str:
-        """Send request to create new environment and return the slug."""
-        from qbraid.api import QbraidSession, RequestsApiError
-
-        session = QbraidSession()
-
+    def gather_local_data(env_name: str) -> Tuple[Path, str]:
+        """Get environment path and slug from name (alias)."""
         installed, aliases = installed_envs_data()
-        for alias, slug_name in aliases.items():
-            if alias == name:
-                slug = slug_name
-                path = installed[slug_name]
-
-                try:
-                    session.delete(f"/environments/{slug}")
-                except RequestsApiError as err:
-                    raise QbraidException("Create environment request failed") from err
+        for alias, slug in aliases.items():
+            if alias == env_name:
+                path = installed[slug]
 
-                return path
+                return path, slug
 
         raise QbraidException(f"Environment '{name}' not found.")
 
-    path = run_progress_task(
-        request_delete_env,
-        name,
-        description="Deleting remote environment data...",
-        error_message="Failed to delete qBraid environment",
-    )
+    slug_path, slug = gather_local_data(name)
 
-    run_progress_task(
-        shutil.rmtree,
-        path,
-        description="Deleting local environment...",
-        error_message="Failed to delete qBraid environment",
-    )
-
-    console = Console()
-    console.print(
-        f"\n[bold green]Successfully delete qBraid environment: "
-        f"[/bold green][bold magenta]{name}[/bold magenta]\n"
+    confirmation_message = (
+        f"⚠️  Warning: You are about to delete the environment '{name}' "
+        f"located at '{slug_path}'.\n"
+        "This will remove all local packages and permanently delete all "
+        "of its associated qBraid environment metadata.\n"
+        "This operation CANNOT be undone.\n\n"
+        "Are you sure you want to continue?"
     )
 
-
-@app.command(name="list")
+    if auto_confirm or typer.confirm(confirmation_message, abort=True):
+        typer.echo("")
+        run_progress_task(
+            request_delete_env,
+            slug,
+            description="Deleting remote environment data...",
+            error_message="Failed to delete qBraid environment",
+        )
+
+        run_progress_task(
+            shutil.rmtree,
+            slug_path,
+            description="Deleting local environment...",
+            error_message="Failed to delete qBraid environment",
+        )
+        typer.echo(f"\nEnvironment '{name}' successfully removed.")
+
+
+@envs_app.command(name="list")
 def envs_list():
     """List installed qBraid environments."""
     installed, aliases = installed_envs_data()
 
+    console = Console()
+
     if len(installed) == 0:
-        print("No qBraid environments installed.")
-        print("\nUse 'qbraid envs create' to create a new environment.")
+        console.print(
+            "No qBraid environments installed.\n\n"
+            + "Use 'qbraid envs create' to create a new environment.",
+            style="yellow",
+        )
         return
 
     alias_path_pairs = [(alias, installed[slug_name]) for alias, slug_name in aliases.items()]
-
     sorted_alias_path_pairs = sorted(
         alias_path_pairs,
         key=lambda x: (x[0] != "default", str(x[1]).startswith(str(Path.home())), x[0]),
@@ -183,21 +229,23 @@ def envs_list():
     current_env_path = Path(sys.executable).parent.parent.parent
 
     max_alias_length = (
-        max(len(alias) for alias, _ in sorted_alias_path_pairs) if sorted_alias_path_pairs else 0
-    )
-    max_path_length = (
-        max(len(str(path)) for _, path in sorted_alias_path_pairs) if sorted_alias_path_pairs else 0
+        max(len(str(alias)) for alias, envpath in sorted_alias_path_pairs)
+        if sorted_alias_path_pairs
+        else 0
     )
 
-    print("# installed environments:")
+    print("# qbraid environments:")
     print("#")
     print("")
+
     for alias, path in sorted_alias_path_pairs:
-        mark = "*  " if path == current_env_path else "   "
-        print(f"{alias.ljust(max_alias_length + 11)}{mark}{str(path).ljust(max_path_length)}")
+        mark = "*" if path == current_env_path else " "
+        # Format each line with spacing based on the longest alias for alignment
+        line = f"{alias.ljust(max_alias_length+3)}{mark} {path}"  # fix the most optimal spacing
+        console.print(line)
 
 
-@app.command(name="activate")
+@envs_app.command(name="activate")
 def envs_activate(
     name: str = typer.Argument(..., help="Name of the environment. Values from 'qbraid envs list'.")
 ):
@@ -219,4 +267,4 @@ def envs_activate(
 
 
 if __name__ == "__main__":
-    app()
+    envs_app()

qbraid_cli/envs/create.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
 """
 Module supporting 'qbraid envs create' command.
 
@@ -11,11 +14,6 @@ import sys
 from typing import Optional
 
 
-def create_alias(slug: str) -> str:
-    """Create an alias from a slug."""
-    return slug[:-7].replace("_", "-").strip("-")
-
-
 def replace_str(target: str, replacement: str, file_path: str) -> None:
     """Replace all instances of string in file"""
     with open(file_path, "r", encoding="utf-8") as file:
@@ -56,7 +54,7 @@ def update_state_json(
     data["install"]["message"] = message
 
     if env_name is not None:
-        data["name"] = env_name.lower()
+        data["name"] = env_name
 
     # Write updated data back to state.json
     with open(state_json_path, "w", encoding="utf-8") as f:
@@ -90,22 +88,17 @@ def create_venv(slug_path: str, prompt: str) -> None:
     update_state_json(slug_path, 1, 1)
 
 
-def create_qbraid_env(slug: str, name: str) -> None:
+def create_qbraid_env_assets(slug: str, alias: str, kernel_name: str, slug_path: str) -> None:
     """Create a qBraid environment including python venv, PS1 configs,
     kernel resource files, and qBraid state.json."""
     # pylint: disable-next=import-outside-toplevel
     from jupyter_client.kernelspec import KernelSpecManager
-    from qbraid.api.system import get_qbraid_envs_paths
 
-    alias = create_alias(slug)
-    display_name = f"Python 3 [{alias}]"
-    envs_dir_path = get_qbraid_envs_paths()[0]
-    slug_path = os.path.join(str(envs_dir_path), slug)
     local_resource_dir = os.path.join(slug_path, "kernels", f"python3_{slug}")
     os.makedirs(local_resource_dir, exist_ok=True)
 
     # create state.json
-    update_state_json(slug_path, 0, 0, env_name=name)
+    update_state_json(slug_path, 0, 0, env_name=alias)
 
     # create kernel.json
     kernel_json_path = os.path.join(local_resource_dir, "kernel.json")
@@ -117,7 +110,7 @@ def create_qbraid_env(slug: str, name: str) -> None:
     else:
         python_exec_path = os.path.join(slug_path, "pyenv", "bin", "python")
     kernel_data["argv"][0] = python_exec_path
-    kernel_data["display_name"] = display_name
+    kernel_data["display_name"] = kernel_name
     with open(kernel_json_path, "w", encoding="utf-8") as file:
         json.dump(kernel_data, file, indent=4)
 

qbraid_cli/envs/data_handling.py

@@ -0,0 +1,140 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module for handling data related to qBraid environments.
+
+"""
+
+import json
+import keyword
+import re
+from pathlib import Path
+from typing import Dict, List, Tuple
+
+import typer
+
+from qbraid_cli.handlers import QbraidException
+
+
+def is_valid_env_name(env_name: str) -> bool:  # pylint: disable=too-many-return-statements
+    """
+    Validates a Python virtual environment name against best practices.
+
+    This function checks if the given environment name is valid based on certain
+    criteria, including length, use of special characters, reserved names, and
+    operating system-specific restrictions.
+
+    Args:
+        env_name (str): The name of the Python virtual environment to validate.
+
+    Returns:
+        bool: True if the name is valid, False otherwise.
+
+    Raises:
+        ValueError: If the environment name is not a string or is empty.
+    """
+    # Basic checks for empty names or purely whitespace names
+    if not env_name or env_name.isspace():
+        return False
+
+    # Check for invalid characters, including shell metacharacters and spaces
+    if re.search(r'[<>:"/\\|?*\s&;()$[\]#~!{}]', env_name):
+        return False
+
+    if env_name.startswith("tmp"):
+        return False
+
+    # Reserved names for Windows (example list, can be expanded)
+    reserved_names = [
+        "CON",
+        "PRN",
+        "AUX",
+        "NUL",
+        "COM1",
+        "COM2",
+        "COM3",
+        "COM4",
+        "COM5",
+        "COM6",
+        "COM7",
+        "COM8",
+        "COM9",
+        "LPT1",
+        "LPT2",
+        "LPT3",
+        "LPT4",
+        "LPT5",
+        "LPT6",
+        "LPT7",
+        "LPT8",
+        "LPT9",
+    ]
+    if env_name.upper() in reserved_names:
+        return False
+
+    if len(env_name) > 20:
+        return False
+
+    # Check against Python reserved words
+    if keyword.iskeyword(env_name):
+        return False
+
+    # Check if it starts with a number, which is not a good practice
+    if env_name[0].isdigit():
+        return False
+
+    return True
+
+
+def validate_env_name(value: str) -> str:
+    """Validate environment name."""
+    if not is_valid_env_name(value):
+        raise typer.BadParameter(
+            f"Invalid environment name '{value}'. " "Please use a valid Python environment name."
+        )
+    return value
+
+
+def installed_envs_data() -> Tuple[Dict[str, Path], Dict[str, str]]:
+    """Gather paths and aliases for all installed qBraid environments."""
+    from qbraid_core.services.environments.paths import get_default_envs_paths, is_valid_slug
+
+    installed = {}
+    aliases = {}
+
+    qbraid_env_paths: List[Path] = get_default_envs_paths()
+
+    for env_path in qbraid_env_paths:
+        for entry in env_path.iterdir():
+            if entry.is_dir() and is_valid_slug(entry.name):
+                installed[entry.name] = entry
+
+                if entry.name == "qbraid_000000":
+                    aliases["default"] = entry.name
+                    continue
+
+                state_json_path = entry / "state.json"
+                if state_json_path.exists():
+                    try:
+                        with open(state_json_path, "r", encoding="utf-8") as f:
+                            data = json.load(f)
+                        aliases[data.get("name", entry.name[:-7])] = entry.name
+                    # pylint: disable-next=broad-exception-caught
+                    except (json.JSONDecodeError, Exception):
+                        aliases[entry.name[:-7]] = entry.name
+                else:
+                    aliases[entry.name[:-7]] = entry.name
+    return installed, aliases
+
+
+def request_delete_env(slug: str) -> str:
+    """Send request to delete environment given slug."""
+    from qbraid_core import QbraidSession, RequestsApiError
+
+    session = QbraidSession()
+
+    try:
+        session.delete(f"/environments/{slug}")
+    except RequestsApiError as err:
+        raise QbraidException("Delete environment request failed") from err

qbraid_cli/exceptions.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
 """
 Module defining custom exceptions for the qBraid CLI.
 

qbraid_cli/handlers.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
 """
 Module providing application support utilities, including abstractions for error handling
 and executing operations with progress tracking within the qBraid CLI.
@@ -38,7 +41,7 @@ def handle_error(
     error_type = error_type or "Error"
     message = message or DEFAULT_ERROR_MESSAGE
     error_prefix = typer.style(f"{error_type}:", fg=typer.colors.RED, bold=True)
-    full_message = f"{error_prefix} {message}\n"
+    full_message = f"\n{error_prefix} {message}\n"
     if include_traceback:
         tb_string = traceback.format_exc()
         full_message += f"\n{tb_string}"

qbraid_cli/jobs/__init__.py

@@ -1,6 +1,9 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
 """
 Module defining the qbraid jobs namespace
 
 """
 
-from .app import app
+from .app import jobs_app