qbraid-cli 0.8.0.dev4__tar.gz → 0.8.0.dev6__tar.gz

{qbraid_cli-0.8.dev4/qbraid_cli.egg-info → qbraid_cli-0.8.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev4
+Version: 0.8.0.dev6
 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
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: jupyter_client<9.0.0,>=7.0.0
-Requires-Dist: qbraid-core>=0.1.2
+Requires-Dist: ipykernel
+Requires-Dist: qbraid-core>=0.1.4
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
@@ -40,7 +41,7 @@ Requires-Dist: pytest; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx~=7.2.6; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
-Requires-Dist: docutils<0.21; extra == "docs"
+Requires-Dist: docutils<0.22; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: build; extra == "docs"
 Requires-Dist: m2r; extra == "docs"

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/docs/index.rst

@@ -103,9 +103,10 @@ Documentation
    :hidden:
 
    tree/qbraid
+   tree/qbraid_admin
    tree/qbraid_configure
    tree/qbraid_credits
    tree/qbraid_devices
    tree/qbraid_envs
    tree/qbraid_jobs
-   tree/qbraid_kernels
+   tree/qbraid_kernels

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/docs/requirements.txt

@@ -1,6 +1,6 @@
 sphinx~=7.2.6
 sphinx-rtd-theme>=1.3,<2.1
-docutils<0.21
+docutils<0.22
 typer
 m2r
 build

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.0.dev4"
+version = "0.8.0.dev6"
 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 @@ dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
     "jupyter_client>=7.0.0,<9.0.0",
-    "qbraid-core>=0.1.2",
+    "ipykernel",
+    "qbraid-core>=0.1.4",
 ]
 requires-python = ">= 3.9"
 
@@ -44,7 +45,7 @@ Discord = "https://discord.gg/KugF6Cnncm"
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
 dev = ["black", "isort", "pylint", "pytest"]
-docs = ["sphinx~=7.2.6", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.21", "toml", "build", "m2r", "typer"]
+docs = ["sphinx~=7.2.6", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.22", "toml", "build", "m2r", "typer"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli/_version.py

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

qbraid_cli-0.8.0.dev6/qbraid_cli/admin/__init__.py

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

qbraid_cli-0.8.0.dev6/qbraid_cli/admin/app.py

@@ -0,0 +1,50 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid admin' namespace.
+
+"""
+
+from typing import List
+
+import typer
+
+from qbraid_cli.admin.headers import check_and_fix_headers
+from qbraid_cli.admin.validation import validate_header_type, validate_paths_exist
+
+# disable pretty_exceptions_show_locals to avoid printing sensative information in the traceback
+admin_app = typer.Typer(
+    help="CI/CD commands for qBraid maintainers.",
+    pretty_exceptions_show_locals=False,
+)
+
+
+@admin_app.command(name="headers")
+def admin_headers(
+    src_paths: List[str] = typer.Argument(
+        ..., help="Source file or directory paths to verify.", callback=validate_paths_exist
+    ),
+    header_type: str = typer.Option(
+        "default",
+        "--type",
+        "-t",
+        help="Type of header to use ('default' or 'gpl').",
+        callback=validate_header_type,
+    ),
+    skip_files: List[str] = typer.Option(
+        [], "--skip", "-s", help="Files to skip during verification.", callback=validate_paths_exist
+    ),
+    fix: bool = typer.Option(
+        False, "--fix", "-f", help="Whether to fix the headers instead of just verifying."
+    ),
+):
+    """
+    Verifies and optionally fixes qBraid headers in specified files and directories.
+
+    """
+    check_and_fix_headers(src_paths, header_type=header_type, skip_files=skip_files, fix=fix)
+
+
+if __name__ == "__main__":
+    admin_app()

qbraid_cli-0.8.0.dev6/qbraid_cli/admin/headers.py

@@ -0,0 +1,193 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Script to verify qBraid copyright file headers
+
+"""
+import os
+import sys
+from typing import List, Optional
+
+from rich.console import Console
+
+# pylint: disable=too-many-branches,too-many-statements
+
+DEFAULT_HEADER = """# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+"""
+
+DEFAULT_HEADER_GPL = """# Copyright (C) 2024 qBraid
+#
+# This file is part of the qBraid-SDK
+#
+# The qBraid-SDK is free software released under the GNU General Public License v3
+# or later. You can redistribute and/or modify it under the terms of the GPL v3.
+# See the LICENSE file in the project root or <https://www.gnu.org/licenses/gpl-3.0.html>.
+#
+# THERE IS NO WARRANTY for the qBraid-SDK, as per Section 15 of the GPL v3.
+"""
+
+HEADER_TYPES = {
+    "default": DEFAULT_HEADER,
+    "gpl": DEFAULT_HEADER_GPL,
+}
+
+
+def check_and_fix_headers(
+    src_paths: List[str],
+    header_type: str = "default",
+    skip_files: Optional[List[str]] = None,
+    fix: bool = False,
+) -> None:
+    """Script to add or verify qBraid copyright file headers"""
+    try:
+        header = HEADER_TYPES[header_type]
+    except KeyError as err:
+        raise ValueError(
+            f"Invalid header type: {HEADER_TYPES}. Expected one of {list(HEADER_TYPES.keys())}"
+        ) from err
+
+    for path in src_paths:
+        if not os.path.exists(path):
+            sys.stderr.write(
+                f"Usage: qbraid verify_headers [OPTIONS] SRC ...\n"
+                f"Try 'qbraid verify_headers --help' for help.\n\n"
+                f"Error: Invalid value for 'SRC ...': Path '{path}' does not exist.\n"
+            )
+            sys.exit(1)
+
+    header_2023 = header.replace("2024", "2023")
+
+    skip_files = skip_files or []
+
+    failed_headers = []
+    fixed_headers = []
+
+    console = Console()
+
+    def should_skip(file_path: str, content: str) -> bool:
+        if file_path in skip_files:
+            return True
+
+        if os.path.basename(file_path) == "__init__.py":
+            return not content.strip()
+
+        skip_header_tag = "# qbraid: skip-header"
+        line_number = 0
+
+        for line in content.splitlines():
+            line_number += 1
+            if 5 <= line_number <= 30 and skip_header_tag in line:
+                return True
+            if line_number > 30:
+                break
+
+        return False
+
+    def replace_or_add_header(file_path: str, fix: bool = False) -> None:
+        with open(file_path, "r", encoding="ISO-8859-1") as f:
+            content = f.read()
+
+        # This finds the start of the actual content after skipping initial whitespace and comments.
+        lines = content.splitlines()
+        first_non_comment_line_index = next(
+            (i for i, line in enumerate(lines) if not line.strip().startswith("#")), None
+        )
+
+        # Prepare the content by stripping leading and trailing whitespace and separating into lines
+        actual_content = (
+            "\n".join(lines[first_non_comment_line_index:]).strip()
+            if first_non_comment_line_index is not None
+            else ""
+        )
+
+        # Check if the content already starts with the header or if the file should be skipped
+        if (
+            content.lstrip().startswith(header)
+            or content.lstrip().startswith(header_2023)
+            or should_skip(file_path, content)
+        ):
+            return
+
+        if not fix:
+            failed_headers.append(file_path)
+        else:
+            # Form the new content by combining the header, one blank line, and the actual content
+            new_content = header.strip() + "\n\n" + actual_content
+            with open(file_path, "w", encoding="ISO-8859-1") as f:
+                f.write(new_content)
+            fixed_headers.append(file_path)
+
+    def process_files_in_directory(directory: str, fix: bool = False) -> int:
+        count = 0
+        if not os.path.isdir(directory):
+            return count
+        for root, _, files in os.walk(directory):
+            for file in files:
+                if file.endswith(".py"):
+                    file_path = os.path.join(root, file)
+                    replace_or_add_header(file_path, fix)
+                    count += 1
+        return count
+
+    checked = 0
+    for item in src_paths:
+        if os.path.isdir(item):
+            checked += process_files_in_directory(item, fix)
+        elif os.path.isfile(item) and item.endswith(".py"):
+            replace_or_add_header(item, fix)
+            checked += 1
+        else:
+            failed_headers.append(item)
+            print(f"File or directory not found: {item}")
+
+    if not fix:
+        if failed_headers:
+            for file in failed_headers:
+                console.print(f"[bold]would fix {file}[/bold]")
+            num_failed = len(failed_headers)
+            num_passed = checked - num_failed
+            s1, s2 = ("", "s") if num_failed == 1 else ("s", "")
+            s_passed = "" if num_passed == 1 else "s"
+            console.print("[bold]\nOh no![/bold] 💥 💔 💥")
+            if num_passed > 0:
+                punc = ", "
+                passed_msg = f"[blue]{num_passed}[/blue] file{s_passed} would be left unchanged."
+            else:
+                punc = "."
+                passed_msg = ""
+
+            failed_msg = f"[bold][blue]{num_failed}[/blue] file{s1} need{s2} updating{punc}[/bold]"
+            console.print(f"{failed_msg}{passed_msg}")
+        elif checked == 0:
+            console.print("[bold]No Python files present. Nothing to do[/bold] 😴")
+        else:
+            s_checked = "" if checked == 1 else "s"
+            console.print("[bold]All done![/bold] ✨ 🚀 ✨")
+            console.print(f"[blue]{checked}[/blue] file{s_checked} would be left unchanged.")
+
+    else:
+        for file in fixed_headers:
+            console.print(f"[bold]fixed {file}[/bold]")
+        num_fixed = len(fixed_headers)
+        num_ok = checked - num_fixed
+        s_fixed = "" if num_fixed == 1 else "s"
+        s_ok = "" if num_ok == 1 else "s"
+        console.print("\n[bold]All done![/bold] ✨ 🚀 ✨")
+        if num_ok > 0:
+            punc = ", "
+            unchanged_msg = f"[blue]{num_ok}[/blue] file{s_ok} left unchanged."
+        else:
+            punc = "."
+            unchanged_msg = ""
+
+        if num_fixed > 0:
+            fixed_msg = f"[bold][blue]{num_fixed}[/blue] file{s_fixed} fixed{punc}[/bold]"
+        else:
+            fixed_msg = ""
+
+        if fixed_msg or unchanged_msg:
+            console.print(f"{fixed_msg}{unchanged_msg}")
+        else:
+            console.print("[bold]No Python files present. Nothing to do[/bold] 😴")

qbraid_cli-0.8.0.dev6/qbraid_cli/admin/validation.py

@@ -0,0 +1,33 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module for validating command arguments for qBraid admin commands.
+
+"""
+
+import os
+from typing import List
+
+import typer
+
+from qbraid_cli.admin.headers import HEADER_TYPES
+from qbraid_cli.handlers import _format_list_items, validate_item
+
+
+def validate_header_type(value: str) -> str:
+    """Validate header type."""
+    header_types = list(HEADER_TYPES.keys())
+    return validate_item(value, header_types, "Header type")
+
+
+def validate_paths_exist(paths: List[str]) -> List[str]:
+    """Verifies that each path in the provided list exists."""
+    non_existent_paths = [path for path in paths if not os.path.exists(path)]
+    if non_existent_paths:
+        if len(non_existent_paths) == 1:
+            raise typer.BadParameter(f"Path '{non_existent_paths[0]}' does not exist")
+        raise typer.BadParameter(
+            f"The following paths do not exist: {_format_list_items(non_existent_paths)}"
+        )
+    return paths

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli/configure/app.py

@@ -7,7 +7,6 @@ Module defining commands in the 'qbraid configure' namespace.
 """
 
 import typer
-from qbraid_core.config import load_config, save_config
 
 from qbraid_cli.configure.actions import default_action
 
@@ -39,6 +38,9 @@ def configure_set(
     profile: str = typer.Option("default", help="Profile name"),
 ):
     """Set configuration value in qbraidrc file."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.config import load_config, save_config
+
     config = load_config()
 
     if profile not in config:
@@ -50,5 +52,18 @@ def configure_set(
     typer.echo("Configuration updated successfully.")
 
 
+@configure_app.command(name="magic")
+def configure_magic():
+    """Configure qBraid IPython magic commands."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.environments import add_magic_config
+
+    add_magic_config()
+
+    typer.echo("Successfully configured qBraid IPython magic commands.")
+    typer.echo("You can now use the qBraid-CLI from inside a Jupyter notebook as follows:")
+    typer.echo("\n\n\t[ ] %load_ext qbraid_magic\n\n\t[ ] %qbraid")
+
+
 if __name__ == "__main__":
     configure_app()

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli/devices/validation.py

@@ -4,7 +4,6 @@
 """
 Module for validating command arguments for qBraid devices commands.
 
-
 """
 
 from typing import Optional, Union

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli/jobs/toggle_braket.py

@@ -120,32 +120,11 @@ def aws_configure_dummy() -> None:
     """
     Initializes AWS configuration and credentials files with placeholder values.
 
-    This function ensures the existence of AWS config and credentials files in the user's home
-    directory. If these files do not already exist, it creates them and populates them with
-    placeholder values for the AWS access key and secret access key. While AWS credentials are not
-    required when submitting quantum tasks through qBraid, Amazon Braket requires these files to be
-    present to prevent configuration errors.
     """
-    aws_dir = Path.home() / ".aws"
-    config_path = aws_dir / "config"
-    credentials_path = aws_dir / "credentials"
-
-    def configure_aws():
-        aws_dir.mkdir(exist_ok=True)
-        if not config_path.exists():
-            config_content = "[default]\nregion = us-east-1\noutput = json\n"
-            config_path.write_text(config_content)
-        if not credentials_path.exists():
-            access_key, secret_key = "MYACCESSKEY", "MYSECRETKEY"
-            credentials_content = (
-                f"[default]\n"
-                f"aws_access_key_id = {access_key}\n"
-                f"aws_secret_access_key = {secret_key}\n"
-            )
-            credentials_path.write_text(credentials_content)
+    from qbraid_core.services.quantum.proxy_braket import aws_configure
 
     try:
-        handle_filesystem_operation(configure_aws, aws_dir)
+        handle_filesystem_operation(aws_configure, Path.home() / ".aws")
     except QbraidException:
         handle_error(message="Failed to configure qBraid quantum jobs.")
 

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli/main.py

@@ -7,8 +7,8 @@ Entrypoint for the qBraid CLI.
 """
 
 import typer
-import urllib3
 
+from qbraid_cli.admin.app import admin_app
 from qbraid_cli.configure.app import configure_app
 from qbraid_cli.credits.app import credits_app
 from qbraid_cli.devices.app import devices_app
@@ -17,14 +17,14 @@ from qbraid_cli.jobs.app import jobs_app
 from qbraid_cli.kernels.app import kernels_app
 
 app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+app.add_typer(admin_app, name="admin")
 app.add_typer(configure_app, name="configure")
+app.add_typer(credits_app, name="credits")
+app.add_typer(devices_app, name="devices")
 app.add_typer(envs_app, name="envs")
 app.add_typer(jobs_app, name="jobs")
-app.add_typer(devices_app, name="devices")
 app.add_typer(kernels_app, name="kernels")
-app.add_typer(credits_app, name="credits")
-
-urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
 def version_callback(value: bool):

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6/qbraid_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.0.dev4
+Version: 0.8.0.dev6
 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
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: jupyter_client<9.0.0,>=7.0.0
-Requires-Dist: qbraid-core>=0.1.2
+Requires-Dist: ipykernel
+Requires-Dist: qbraid-core>=0.1.4
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
@@ -40,7 +41,7 @@ Requires-Dist: pytest; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx~=7.2.6; extra == "docs"
 Requires-Dist: sphinx-rtd-theme<2.1,>=1.3; extra == "docs"
-Requires-Dist: docutils<0.21; extra == "docs"
+Requires-Dist: docutils<0.22; extra == "docs"
 Requires-Dist: toml; extra == "docs"
 Requires-Dist: build; extra == "docs"
 Requires-Dist: m2r; extra == "docs"

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli.egg-info/SOURCES.txt

@@ -54,6 +54,10 @@ qbraid_cli.egg-info/dependency_links.txt
 qbraid_cli.egg-info/entry_points.txt
 qbraid_cli.egg-info/requires.txt
 qbraid_cli.egg-info/top_level.txt
+qbraid_cli/admin/__init__.py
+qbraid_cli/admin/app.py
+qbraid_cli/admin/headers.py
+qbraid_cli/admin/validation.py
 qbraid_cli/configure/__init__.py
 qbraid_cli/configure/actions.py
 qbraid_cli/configure/app.py
@@ -109,7 +113,6 @@ tests/test_jobs/test_app/test_jobs_enable.py
 tests/test_jobs/test_app/test_jobs_list.py
 tests/test_jobs/test_app/test_jobs_state.py
 tests/test_jobs/test_toggle_braket/__init__.py
-tests/test_jobs/test_toggle_braket/test_aws_configure_dummy.py
 tests/test_jobs/test_toggle_braket/test_confirm_updates.py
 tests/test_jobs/test_toggle_braket/test_disable_braket.py
 tests/test_jobs/test_toggle_braket/test_enable_braket.py

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/qbraid_cli.egg-info/requires.txt

@@ -1,7 +1,8 @@
 typer>=0.12.1
 rich>=10.11.0
 jupyter_client<9.0.0,>=7.0.0
-qbraid-core>=0.1.2
+ipykernel
+qbraid-core>=0.1.4
 
 [dev]
 black
@@ -12,7 +13,7 @@ pytest
 [docs]
 sphinx~=7.2.6
 sphinx-rtd-theme<2.1,>=1.3
-docutils<0.21
+docutils<0.22
 toml
 build
 m2r

{qbraid_cli-0.8.dev4 → qbraid_cli-0.8.0.dev6}/tests/test_configure/test_configure_set.py

@@ -17,8 +17,8 @@ def test_configure_set(capsys):
     mock_save_config = MagicMock()
 
     with (
-        patch("qbraid_cli.configure.app.load_config", mock_load_config),
-        patch("qbraid_cli.configure.app.save_config", mock_save_config),
+        patch("qbraid_core.config.load_config", mock_load_config),
+        patch("qbraid_core.config.save_config", mock_save_config),
     ):
         configure_set("test_config", "test_value", "test_profile")
 

qbraid_cli-0.8.dev4/tests/test_jobs/test_toggle_braket/test_aws_configure_dummy.py

@@ -1,49 +0,0 @@
-# Copyright (c) 2024, qBraid Development Team
-# All rights reserved.
-
-"""
-Unit tests for the aws_configure_dummy function in the toggle_braket module.
-
-"""
-
-from unittest.mock import patch
-
-from qbraid_cli.jobs.toggle_braket import aws_configure_dummy
-
-
-def test_aws_directory_and_files_creation():
-    """Test create AWS dummy configuration files."""
-    with (
-        patch("pathlib.Path.mkdir") as mock_mkdir,
-        patch("pathlib.Path.exists", side_effect=[False, False]),
-        patch("pathlib.Path.write_text") as mock_write_text,
-    ):
-        aws_configure_dummy()
-        mock_mkdir.assert_called_once()
-        assert mock_write_text.call_count == 2
-
-
-def test_preservation_of_existing_files():
-    """Test if the correct placeholder values are written to the files when they are created."""
-    with (
-        patch("pathlib.Path.exists", side_effect=[True, True]),
-        patch("pathlib.Path.write_text") as mock_write_text,
-    ):
-        aws_configure_dummy()
-        mock_write_text.assert_not_called()
-
-
-def test_correct_content_in_files():
-    """Test if the correct placeholder values are written to the files when they are created."""
-    expected_config_content = "[default]\nregion = us-east-1\noutput = json\n"
-    expected_credentials_content = (
-        "[default]\naws_access_key_id = MYACCESSKEY\naws_secret_access_key = MYSECRETKEY\n"
-    )
-
-    with (
-        patch("pathlib.Path.exists", side_effect=[False, False]),
-        patch("pathlib.Path.write_text") as mock_write_text,
-    ):
-        aws_configure_dummy()
-        mock_write_text.assert_any_call(expected_config_content)
-        mock_write_text.assert_any_call(expected_credentials_content)