qbraid-cli 0.10.9a0__tar.gz → 0.11.0__tar.gz

{qbraid_cli-0.10.9a0/qbraid_cli.egg-info → qbraid_cli-0.11.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: qbraid-cli
-Version: 0.10.9a0
+Version: 0.11.0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
-License: Proprietary
+License-Expression: LicenseRef-Proprietary
 Project-URL: Homepage, https://docs.qbraid.com/cli/user-guide/overview
 Project-URL: Documentation, https://docs.qbraid.com/cli/api-reference/qbraid
 Project-URL: Bug Tracker, https://github.com/qBraid/community/issues
@@ -12,7 +12,6 @@ Keywords: qbraid,cli,quantum,cloud
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
-Classifier: License :: Other/Proprietary License
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux

{qbraid_cli-0.10.9a0 → qbraid_cli-0.11.0}/pyproject.toml

@@ -1,20 +1,20 @@
 [build-system]
-requires = ["setuptools>=42", "wheel", "setuptools_scm"]
+requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.10.9a0"
+version = "0.11.0"
 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" }]
-license = { text = "Proprietary" }
+license = "LicenseRef-Proprietary"
+license-files = ["LICENSE"]
 keywords = ["qbraid", "cli", "quantum", "cloud"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Natural Language :: English",
-    "License :: Other/Proprietary License",
     "Intended Audience :: System Administrators",
     "Operating System :: Microsoft :: Windows",
     "Operating System :: POSIX :: Linux",
@@ -50,9 +50,6 @@ dev = ["isort", "black", "pytest", "pytest-cov", "pytest-asyncio"]
 [project.scripts]
 qbraid = "qbraid_cli.main:app"
 
-[tool.setuptools_scm]
-write_to = "qbraid_cli/_version.py"
-
 [tool.black]
 line-length = 100
 target-version = ["py39", "py310", "py311", "py312"]

qbraid_cli-0.11.0/qbraid_cli/_version.py

@@ -0,0 +1,18 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining package version.
+
+"""
+
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("qbraid-cli")
+except Exception:  # pylint: disable=broad-exception-caught # pragma: no cover
+    __version__ = "dev"
+
+__version_tuple__ = tuple(int(part) if part.isdigit() else part for part in __version__.split("."))
+
+__all__ = ["__version__", "__version_tuple__"]

{qbraid_cli-0.10.9a0 → qbraid_cli-0.11.0}/qbraid_cli/configure/app.py

@@ -131,5 +131,92 @@ def configure_magic():
     console.print(f"\n\t{in_1}\n\n\t{in_2}\n")
 
 
+@configure_app.command(name="claude")
+def configure_claude(
+    action: str = typer.Argument(
+        ...,
+        help="Action to perform: 'add', 'remove', or 'show'",
+    ),
+    overwrite: bool = typer.Option(
+        False,
+        "--overwrite",
+        help="Overwrite existing MCP server configuration",
+    ),
+):
+    """
+    Manage qBraid MCP server in Claude Desktop configuration.
+
+    Add, remove, or show the qBraid MCP server in your Claude Desktop config
+    (claude_desktop_config.json).
+    """
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_cli.configure.claude_config import (
+        add_qbraid_mcp_server,
+        get_claude_config_path,
+        get_qbraid_mcp_server_config,
+        remove_qbraid_mcp_server,
+    )
+
+    console = Console()
+
+    # Validate action
+    valid_actions = ["add", "remove", "show"]
+    if action not in valid_actions:
+        console.print(
+            f"[red]Error:[/red] Invalid action '{action}'. "
+            f"Must be one of: {', '.join(valid_actions)}"
+        )
+        raise typer.Exit(1)
+
+    # Check if Claude config exists (except for show which can work without it)
+    if action != "show":
+        config_path = get_claude_config_path()
+        if config_path is None:
+            console.print(
+                "[yellow]Warning:[/yellow] Claude Desktop config file not found.\n"
+                "Expected locations:\n"
+                "  - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json\n"
+                "  - Windows: %APPDATA%\\Claude\\claude_desktop_config.json\n"
+                "  - Linux: ~/.config/Claude/claude_desktop_config.json\n\n"
+                "Creating new config file..."
+            )
+
+    # Perform action
+    if action == "add":
+        success, message = add_qbraid_mcp_server(overwrite=overwrite)
+        if success:
+            console.print(f"[green]Success:[/green] {message}")
+            console.print(
+                "\n[yellow]Note:[/yellow] You may need to restart Claude Desktop "
+                "for changes to take effect."
+            )
+        else:
+            console.print(f"[red]Error:[/red] {message}")
+            raise typer.Exit(1)
+
+    elif action == "remove":
+        success, message = remove_qbraid_mcp_server()
+        if success:
+            console.print(f"[green]Success:[/green] {message}")
+            console.print(
+                "\n[yellow]Note:[/yellow] You may need to restart Claude Desktop "
+                "for changes to take effect."
+            )
+        else:
+            console.print(f"[red]Error:[/red] {message}")
+            raise typer.Exit(1)
+
+    elif action == "show":
+        server_config = get_qbraid_mcp_server_config()
+        if server_config is None:
+            console.print("No qBraid MCP server found in Claude Desktop configuration.")
+            return
+
+        console.print("\n[cyan]qBraid MCP Server Configuration:[/cyan]\n")
+        console.print(f"  Command: {server_config.get('command', 'N/A')}")
+        console.print(f"  Args: {server_config.get('args', [])}")
+        console.print()
+
+
 if __name__ == "__main__":
     configure_app()

qbraid_cli-0.11.0/qbraid_cli/configure/claude_config.py

@@ -0,0 +1,215 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Utility functions for managing Claude Desktop configuration.
+
+This module provides cross-platform support for locating and updating
+the claude_desktop_config.json file used by Claude Desktop.
+"""
+
+import json
+import os
+import platform
+import shutil
+from pathlib import Path
+from typing import Optional
+
+
+def get_claude_config_path() -> Optional[Path]:
+    """
+    Get the path to the Claude Desktop configuration file.
+
+    Returns the platform-specific path to claude_desktop_config.json:
+    - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
+    - Windows: %APPDATA%\\Claude\\claude_desktop_config.json
+    - Linux: ~/.config/Claude/claude_desktop_config.json
+
+    Returns:
+        Path to the config file if it exists, None otherwise
+    """
+    system = platform.system()
+
+    if system == "Darwin":  # macOS
+        config_path = Path.home() / "Library" / "Application Support" / "Claude"
+    elif system == "Windows":
+        appdata = os.environ.get("APPDATA")
+        if not appdata:
+            return None
+        config_path = Path(appdata) / "Claude"
+    elif system == "Linux":
+        config_path = Path.home() / ".config" / "Claude"
+    else:
+        return None
+
+    config_file = config_path / "claude_desktop_config.json"
+    return config_file if config_file.exists() else None
+
+
+def load_claude_config() -> dict:
+    """
+    Load the Claude Desktop configuration file.
+
+    Returns:
+        Configuration dictionary. If file doesn't exist, returns empty dict.
+
+    Raises:
+        json.JSONDecodeError: If config file exists but contains invalid JSON
+        OSError: If there are permission issues reading the file
+    """
+    config_path = get_claude_config_path()
+
+    if config_path is None or not config_path.exists():
+        return {}
+
+    with open(config_path, "r", encoding="utf-8") as f:
+        return json.load(f)
+
+
+def save_claude_config(config: dict) -> Path:
+    """
+    Save the Claude Desktop configuration file.
+
+    Creates the configuration directory if it doesn't exist.
+
+    Args:
+        config: Configuration dictionary to save
+
+    Returns:
+        Path to the saved configuration file
+
+    Raises:
+        OSError: If there are permission issues or the platform is unsupported
+    """
+    system = platform.system()
+
+    if system == "Darwin":  # macOS
+        config_dir = Path.home() / "Library" / "Application Support" / "Claude"
+    elif system == "Windows":
+        appdata = os.environ.get("APPDATA")
+        if not appdata:
+            raise OSError("APPDATA environment variable not set")
+        config_dir = Path(appdata) / "Claude"
+    elif system == "Linux":
+        config_dir = Path.home() / ".config" / "Claude"
+    else:
+        raise OSError(f"Unsupported platform: {system}")
+
+    # Create directory if it doesn't exist
+    config_dir.mkdir(parents=True, exist_ok=True)
+
+    config_file = config_dir / "claude_desktop_config.json"
+
+    # Write config with pretty formatting
+    with open(config_file, "w", encoding="utf-8") as f:
+        json.dump(config, f, indent=2, ensure_ascii=False)
+        f.write("\n")  # Add trailing newline
+
+    return config_file
+
+
+def add_qbraid_mcp_server(overwrite: bool = False) -> tuple[bool, str]:
+    """
+    Add qBraid MCP server configuration to Claude Desktop config.
+
+    Args:
+        overwrite: If True, overwrite existing qbraid entry
+
+    Returns:
+        Tuple of (success: bool, message: str)
+    """
+    # Get the full path to qbraid executable
+    qbraid_path = shutil.which("qbraid")
+    if not qbraid_path:
+        return (
+            False,
+            "Could not find qbraid executable in PATH. "
+            "Please ensure qbraid-cli is installed and accessible.",
+        )
+
+    try:
+        config = load_claude_config()
+    except json.JSONDecodeError as e:
+        return False, f"Invalid JSON in Claude config file: {e}"
+    except OSError as e:
+        return False, f"Error reading Claude config file: {e}"
+
+    # Initialize mcpServers section if it doesn't exist
+    if "mcpServers" not in config:
+        config["mcpServers"] = {}
+
+    # Determine server name
+    server_name = "qbraid"
+
+    # Check if server already exists
+    if server_name in config["mcpServers"] and not overwrite:
+        return (
+            False,
+            f"MCP server '{server_name}' already exists in config. "
+            "Use --overwrite to replace it.",
+        )
+
+    # Build server configuration with full path to qbraid
+    server_config = {"command": qbraid_path, "args": ["mcp", "serve"]}
+
+    # Add server to config
+    config["mcpServers"][server_name] = server_config
+
+    # Save config
+    try:
+        config_path = save_claude_config(config)
+        action = "Updated" if server_name in config["mcpServers"] else "Added"
+        return True, f"{action} MCP server '{server_name}' in [cyan]{config_path}[/cyan]"
+    except OSError as e:
+        return False, f"Error saving Claude config file: {e}"
+
+
+def remove_qbraid_mcp_server() -> tuple[bool, str]:
+    """
+    Remove qBraid MCP server configuration from Claude Desktop config.
+
+    Returns:
+        Tuple of (success: bool, message: str)
+    """
+    try:
+        config = load_claude_config()
+    except json.JSONDecodeError as e:
+        return False, f"Invalid JSON in Claude config file: {e}"
+    except OSError as e:
+        return False, f"Error reading Claude config file: {e}"
+
+    if "mcpServers" not in config:
+        return False, "No mcpServers section found in Claude config"
+
+    server_name = "qbraid"
+
+    if server_name not in config["mcpServers"]:
+        return False, f"MCP server '{server_name}' not found in config"
+
+    # Remove server
+    del config["mcpServers"][server_name]
+
+    # Save config
+    try:
+        config_path = save_claude_config(config)
+        return True, f"Removed MCP server '{server_name}' from [cyan]{config_path}[/cyan]"
+    except OSError as e:
+        return False, f"Error saving Claude config file: {e}"
+
+
+def get_qbraid_mcp_server_config() -> Optional[dict]:
+    """
+    Get qBraid MCP server configuration from Claude Desktop config.
+
+    Returns:
+        Server configuration dict if found, None otherwise
+    """
+    try:
+        config = load_claude_config()
+    except (json.JSONDecodeError, OSError):
+        return None
+
+    if "mcpServers" not in config:
+        return None
+
+    return config["mcpServers"].get("qbraid")

{qbraid_cli-0.10.9a0 → qbraid_cli-0.11.0/qbraid_cli.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: qbraid-cli
-Version: 0.10.9a0
+Version: 0.11.0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
-License: Proprietary
+License-Expression: LicenseRef-Proprietary
 Project-URL: Homepage, https://docs.qbraid.com/cli/user-guide/overview
 Project-URL: Documentation, https://docs.qbraid.com/cli/api-reference/qbraid
 Project-URL: Bug Tracker, https://github.com/qBraid/community/issues
@@ -12,7 +12,6 @@ Keywords: qbraid,cli,quantum,cloud
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
-Classifier: License :: Other/Proprietary License
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux

qbraid_cli-0.11.0/qbraid_cli.egg-info/SOURCES.txt

@@ -0,0 +1,50 @@
+LICENSE
+README.md
+pyproject.toml
+qbraid_cli/__init__.py
+qbraid_cli/_version.py
+qbraid_cli/exceptions.py
+qbraid_cli/handlers.py
+qbraid_cli/main.py
+qbraid_cli/py.typed
+qbraid_cli.egg-info/PKG-INFO
+qbraid_cli.egg-info/SOURCES.txt
+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/account/__init__.py
+qbraid_cli/account/app.py
+qbraid_cli/admin/__init__.py
+qbraid_cli/admin/app.py
+qbraid_cli/admin/headers.py
+qbraid_cli/admin/validation.py
+qbraid_cli/chat/__init__.py
+qbraid_cli/chat/app.py
+qbraid_cli/configure/__init__.py
+qbraid_cli/configure/actions.py
+qbraid_cli/configure/app.py
+qbraid_cli/configure/claude_config.py
+qbraid_cli/devices/__init__.py
+qbraid_cli/devices/app.py
+qbraid_cli/devices/validation.py
+qbraid_cli/envs/__init__.py
+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
+qbraid_cli/jobs/validation.py
+qbraid_cli/kernels/__init__.py
+qbraid_cli/kernels/app.py
+qbraid_cli/mcp/__init__.py
+qbraid_cli/mcp/app.py
+qbraid_cli/mcp/serve.py
+qbraid_cli/pip/__init__.py
+qbraid_cli/pip/app.py
+qbraid_cli/pip/hooks.py
+tests/test_version.py

qbraid_cli-0.11.0/tests/test_version.py

@@ -0,0 +1,151 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Unit tests for qbraid_cli._version module.
+"""
+
+from unittest.mock import patch
+
+import qbraid_cli._version as version_module
+
+
+def test_version_is_string():
+    """Test that __version__ is a string."""
+    assert isinstance(version_module.__version__, str)
+
+
+def test_version_not_empty():
+    """Test that __version__ is not empty."""
+    assert len(version_module.__version__) > 0
+
+
+def test_version_format():
+    """Test that __version__ follows semantic versioning or is 'dev'."""
+    version = version_module.__version__
+    if version != "dev":
+        # Should have at least major.minor format
+        parts = version.split(".")
+        assert len(parts) >= 2, "Version should have at least major.minor"
+        # First two parts should be numeric
+        assert parts[0].isdigit(), "Major version should be numeric"
+        assert parts[1].split("-")[0].isdigit(), "Minor version should be numeric"
+
+
+def test_version_tuple_is_tuple():
+    """Test that __version_tuple__ is a tuple."""
+    assert isinstance(version_module.__version_tuple__, tuple)
+
+
+def test_version_tuple_not_empty():
+    """Test that __version_tuple__ is not empty."""
+    assert len(version_module.__version_tuple__) > 0
+
+
+def test_version_tuple_structure():
+    """Test that __version_tuple__ has expected structure."""
+    version_tuple = version_module.__version_tuple__
+    # Should have at least 2 elements (major, minor)
+    assert len(version_tuple) >= 2
+    # First two elements should be integers (major, minor)
+    if version_module.__version__ != "dev":
+        assert isinstance(version_tuple[0], int), "Major version should be int"
+
+
+def test_version_tuple_matches_version_string():
+    """Test that __version_tuple__ components match __version__ string."""
+    version = version_module.__version__
+    version_tuple = version_module.__version_tuple__
+
+    parts = version.split(".")
+    for i, part in enumerate(parts):
+        if i < len(version_tuple):
+            if part.isdigit():
+                assert version_tuple[i] == int(part), f"Tuple element {i} should match version part"
+            else:
+                assert version_tuple[i] == part, f"Tuple element {i} should match version part"
+
+
+def test_module_exports():
+    """Test that __all__ contains expected exports."""
+    assert hasattr(version_module, "__all__")
+    assert "__version__" in version_module.__all__
+    assert "__version_tuple__" in version_module.__all__
+
+
+def test_version_fallback_on_metadata_error():
+    """Test that __version__ falls back to 'dev' when metadata is not available."""
+    # pylint: disable=import-outside-toplevel,reimported
+    import sys
+
+    with patch("importlib.metadata.version", side_effect=Exception("Metadata not found")):
+        # Remove from sys.modules to force reload
+        if "qbraid_cli._version" in sys.modules:
+            del sys.modules["qbraid_cli._version"]
+
+        # Import again (will use mocked metadata.version)
+        import qbraid_cli._version as reloaded_version
+
+        # Should fall back to 'dev'
+        assert reloaded_version.__version__ == "dev"
+
+        # Clean up - reload the original module
+        if "qbraid_cli._version" in sys.modules:
+            del sys.modules["qbraid_cli._version"]
+        import qbraid_cli._version  # noqa: F401  # pylint: disable=unused-import
+
+
+def test_version_tuple_handles_dev():
+    """Test that __version_tuple__ correctly handles 'dev' version."""
+    # pylint: disable=import-outside-toplevel,reimported
+    import sys
+
+    with patch("importlib.metadata.version", side_effect=Exception("Metadata not found")):
+        # Remove from sys.modules to force reload
+        if "qbraid_cli._version" in sys.modules:
+            del sys.modules["qbraid_cli._version"]
+
+        # Import again (will use mocked metadata.version)
+        import qbraid_cli._version as reloaded_version
+
+        # Should fall back to 'dev'
+        assert reloaded_version.__version__ == "dev"
+        assert reloaded_version.__version_tuple__ == ("dev",)
+
+        # Clean up
+        if "qbraid_cli._version" in sys.modules:
+            del sys.modules["qbraid_cli._version"]
+        import qbraid_cli._version  # noqa: F401  # pylint: disable=unused-import
+
+
+def test_version_tuple_handles_prerelease():
+    """Test that __version_tuple__ correctly handles pre-release versions."""
+    # Example: "0.10.9.dev" or "0.10.9-beta.1"
+    test_version = "0.10.9.dev"
+    parts = test_version.split(".")
+    version_tuple = tuple(int(part) if part.isdigit() else part for part in parts)
+
+    # Should have 4 elements: (0, 10, 9, 'dev')
+    assert len(version_tuple) == 4
+    assert version_tuple[0] == 0
+    assert version_tuple[1] == 10
+    assert version_tuple[2] == 9
+    assert version_tuple[3] == "dev"
+
+
+def test_version_comparison():
+    """Test that version tuples can be compared."""
+    # Create sample version tuples
+    v1 = (0, 10, 8)
+    v2 = (0, 10, 9)
+    v3 = (1, 0, 0)
+
+    assert v1 < v2
+    assert v2 < v3
+    assert v1 < v3
+
+    # Test with current version tuple if it's not 'dev'
+    if version_module.__version__ != "dev":
+        current = version_module.__version_tuple__[:3]  # Take major.minor.patch
+        # Should be comparable to tuples - test reflexivity
+        assert current == current  # pylint: disable=comparison-with-itself

qbraid_cli-0.10.9a0/.env.example

@@ -1,4 +0,0 @@
-QBRAID_API_KEY= # YOURAPIKEY
-QBRAID_ENVS_PATH= # default: ~/.qbraid/environments
-QBRAID_CONFIG_FILE= # default: ~/.qbraid/qbraidrc
-QBRAID_CLI_SHOW_PROGRESS= # default: true

qbraid_cli-0.10.9a0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,34 +0,0 @@
-name: Bug report 🚩
-description: Create a report to help us improve
-title: "[BUG] "
-labels: [bug]
-
-body:
-  - type: markdown
-    attributes:
-      value: "Thanks for taking the time to fill out our bug report form."
-
-  - type: textarea
-    attributes:
-      label: Environment
-      value: |
-        - **qBraid-CORE version**:
-        - **qBraid-CLI version**:
-        - **Python version**:
-        - **Operating system**:
-    validations:
-      required: true
-  
-  - type: textarea
-    attributes:
-      label: What happened?
-      description: Please provide a detailed description of the bug, accompanied by a minimal code example that demonstrates how the error(s) can be reproduced.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Suggestions (Optional)
-      description: We warmly welcome any recommendations on potential fixes, insights, or considerations that contributors should keep in mind when working to resolve this issue.
-    validations:
-      required: false

qbraid_cli-0.10.9a0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,25 +0,0 @@
-name: Feature request 💡
-description: Suggest an idea for this project
-title: "[FEATURE] "
-labels: [enhancement]
-
-body:
-  - type: markdown
-    attributes:
-      value: "Thank you for taking the time to suggest a feature. Please fill out the details below to help us understand your idea better."
-
-  - type: textarea
-    id: feature-description
-    attributes:
-      label: Feature Description
-      description: "Describe the feature you'd like and the problem it solves. Include any specific use cases that illustrate its benefits."
-      placeholder: "Please describe the feature in detail."
-    validations:
-      required: true
-  
-  - type: textarea
-    attributes:
-      label: Implementation (Optional)
-      description: "Do you have an idea for how this could be implemented? Please include those details here."
-    validations:
-      required: false

qbraid_cli-0.10.9a0/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +0,0 @@
-<!-- Please link or tag any issues that is PR closes -->
-
-# Changes