qbraid-core 0.2.3__tar.gz → 0.3.0__tar.gz

{qbraid_core-0.2.3/qbraid_core.egg-info → qbraid_core-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qbraid-core
-Version: 0.2.3
+Version: 0.3.0
 Summary: Python library with core abstractions for software development in the qBraid ecosystem.
 Author: qBraid Development Team
 Author-email: contact@qbraid.com
@@ -16,7 +16,6 @@ Classifier: Intended Audience :: System Administrators
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -31,7 +30,7 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -41,15 +40,14 @@ Requires-Dist: pydantic>2.0.0
 Provides-Extra: runner
 Requires-Dist: numpy; extra == "runner"
 Requires-Dist: psutil; extra == "runner"
+Provides-Extra: compute
+Requires-Dist: websockets>=11.0; extra == "compute"
 Provides-Extra: environments
 Requires-Dist: jupyter_client>=7.1.0; extra == "environments"
 Requires-Dist: ipython; extra == "environments"
-Requires-Dist: pyyaml>6.0.0; extra == "environments"
 Requires-Dist: ipykernel; extra == "environments"
+Requires-Dist: pyyaml>6.0.0; extra == "environments"
 Requires-Dist: zstandard; extra == "environments"
-Requires-Dist: filelock; extra == "environments"
-Provides-Extra: mcp
-Requires-Dist: websockets>=11.0; extra == "mcp"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -71,8 +69,7 @@ Dynamic: license-file
 [![Python verions](https://img.shields.io/pypi/pyversions/qbraid-core.svg?color=blue)](https://pypi.org/project/qbraid-core/)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/qBraid/community/issues)
 
-Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the [qBraid CLI](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and the
-[jupyter-environment-manager](https://pypi.org/project/jupyter-environment-manager/).
+Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the [qBraid CLI](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and [qBraid Lab](https://docs.qbraid.com/v2/lab/user-guide/overview).
 
 You can find the latest, most up to date, documentation [here](https://qbraid.github.io/qbraid-core/), including a list of services that are supported.
 
@@ -108,7 +105,7 @@ Or generate your `~/.qbraid/qbraidrc` file via the qbraid-core Python interface:
 >>> session = QbraidSessionV1(api_key='API_KEY')
 >>> session.save_config()
 >>> session.get_available_services()
-['environments', 'runtime', 'storage']
+['agents', 'compute', 'environments', 'projects', 'runtime', 'skills', 'storage']
 ```
 
 Other credential configuration methods are available using the [qBraid-CLI](https://docs.qbraid.com/v2/cli/api-reference/qbraid_configure).

{qbraid_core-0.2.3 → qbraid_core-0.3.0}/README.md

@@ -6,8 +6,7 @@
 [![Python verions](https://img.shields.io/pypi/pyversions/qbraid-core.svg?color=blue)](https://pypi.org/project/qbraid-core/)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/qBraid/community/issues)
 
-Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the [qBraid CLI](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and the
-[jupyter-environment-manager](https://pypi.org/project/jupyter-environment-manager/).
+Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the [qBraid CLI](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and [qBraid Lab](https://docs.qbraid.com/v2/lab/user-guide/overview).
 
 You can find the latest, most up to date, documentation [here](https://qbraid.github.io/qbraid-core/), including a list of services that are supported.
 
@@ -43,7 +42,7 @@ Or generate your `~/.qbraid/qbraidrc` file via the qbraid-core Python interface:
 >>> session = QbraidSessionV1(api_key='API_KEY')
 >>> session.save_config()
 >>> session.get_available_services()
-['environments', 'runtime', 'storage']
+['agents', 'compute', 'environments', 'projects', 'runtime', 'skills', 'storage']
 ```
 
 Other credential configuration methods are available using the [qBraid-CLI](https://docs.qbraid.com/v2/cli/api-reference/qbraid_configure).

{qbraid_core-0.2.3 → qbraid_core-0.3.0}/docs/api/qbraid_core.services.rst

@@ -11,8 +11,11 @@ Submodules
 .. autosummary::
    :toctree: ../stubs/
 
+   agents
+   compute
    environments
-   mcp
+   projects
    quantum
    runtime
+   skills
    storage

{qbraid_core-0.2.3 → qbraid_core-0.3.0}/docs/index.rst

@@ -16,7 +16,7 @@ Overview
 
 Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface
 to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the `qBraid CLI <https://pypi.org/project/qbraid-cli/>`_,
-the `qBraid SDK <https://pypi.org/project/qbraid/>`_, and the `jupyter-environment-manager <https://pypi.org/project/jupyter-environment-manager/>`_.
+the `qBraid SDK <https://pypi.org/project/qbraid/>`_, and `qBraid Lab <https://docs.qbraid.com/v2/lab/user-guide/overview/>`_.
 
 .. seealso::
 

{qbraid_core-0.2.3 → qbraid_core-0.3.0}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-core"
-version = "0.2.3"
+version = "0.3.0"
 authors = [{name = "qBraid Development Team"}, {email = "contact@qbraid.com"}]
 description = "Python library with core abstractions for software development in the qBraid ecosystem."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 keywords = ["qbraid", "quantum", "cloud"]
 license = {text = "Proprietary"}
 classifiers = [
@@ -18,7 +18,6 @@ classifiers = [
     "Natural Language :: English",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -34,7 +33,12 @@ classifiers = [
     "Operating System :: Unix",
     "Operating System :: MacOS"
 ]
-dependencies = ["requests", "urllib3", "packaging", "pydantic>2.0.0"]
+dependencies = [
+    "requests",
+    "urllib3",
+    "packaging",
+    "pydantic>2.0.0",
+]
 
 [project.urls]
 Homepage = "https://sdk.qbraid.com/qbraid-core/"
@@ -44,14 +48,14 @@ Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
 runner = ["numpy", "psutil"]
-environments = ["jupyter_client>=7.1.0", "ipython", "pyyaml>6.0.0", "ipykernel", "zstandard", "filelock"]
-mcp = ["websockets>=11.0"]
+compute = ["websockets>=11.0"]
+environments = ["jupyter_client>=7.1.0", "ipython", "ipykernel", "pyyaml>6.0.0", "zstandard"]
 test = ["pytest", "pytest-cov", "pytest-asyncio"]
 docs = ["sphinx>=7.2.6,<8.3.0", "sphinx-rtd-theme>=1.3,<3.1", "sphinx-autodoc-typehints>=1.24,<3.2", "docutils<0.23", "sphinx-copybutton", "sphinx-pydantic"]
 
 [tool.black]
 line-length = 100
-target-version = ["py39", "py310", "py311", "py312", "py313"]
+target-version = ["py310", "py311", "py312", "py313"]
 
 [tool.isort]
 profile = "black"
@@ -63,10 +67,13 @@ line_length = 100
 
 [tool.pylint.'MESSAGES CONTROL']
 max-line-length = 100
-disable = "W0511,W0212,E0401"
+disable = "C0302,C0415,E0401,E1101,R0401,R0801,R0902,R0903,R0904,R0911,R0912,R0913,R0914,R0915,R0917,R1702,R1732,W0150,W0212,W0511,W0613,W0621,W0705,W0718"
 
 [tool.pylint.MASTER]
 
+[tool.setuptools.package-data]
+qbraid_core = ["py.typed"]
+
 [tool.pytest.ini_options]
 addopts = "--cov=qbraid_core --cov-report=term --cov-report=xml"
 testpaths = ["tests"]

qbraid_core-0.3.0/qbraid_core/_build_info.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Build metadata — auto-generated by bin/build_wheel.py during wheel builds.
+For editable installs, this file contains placeholder values.
+"""
+
+BUILD_INFO = {
+    "version": "dev",
+    "base_version": "dev",
+    "branch": "",
+    "commit": "",
+    "commit_full": "",
+    "commit_message": "",
+    "recent_changes": [],
+    "build_date": "",
+    "dirty": True,
+}

{qbraid_core-0.2.3 → qbraid_core-0.3.0}/qbraid_core/_version.py

@@ -6,6 +6,7 @@ Module defining package version.
 """
 
 import importlib.metadata
+from typing import Optional
 
 try:
     __version__ = importlib.metadata.version("qbraid-core")
@@ -14,4 +15,11 @@ except Exception:  # pylint: disable=broad-exception-caught # pragma: no cover
 
 __version_tuple__ = tuple(int(part) if part.isdigit() else part for part in __version__.split("."))
 
-__all__ = ["__version__", "__version_tuple__"]
+BUILD_INFO: Optional[dict[str, object]]
+
+try:
+    from ._build_info import BUILD_INFO  # noqa: F811
+except ImportError:
+    BUILD_INFO = None
+
+__all__ = ["__version__", "__version_tuple__", "BUILD_INFO"]

qbraid_core-0.3.0/qbraid_core/diagnostics/__init__.py

@@ -0,0 +1,16 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Diagnostics module for troubleshooting qBraid platform issues.
+
+Usage:
+    from qbraid_core.diagnostics import run_diagnostics
+    report = run_diagnostics()
+    print(report.summary())
+"""
+
+from .models import CheckResult, CheckStatus, DiagnosticReport
+from .runner import run_diagnostics
+
+__all__ = ["CheckResult", "CheckStatus", "DiagnosticReport", "run_diagnostics"]

qbraid_core-0.3.0/qbraid_core/diagnostics/auth.py

@@ -0,0 +1,140 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""Authentication diagnostic checks."""
+
+from .models import CheckResult, CheckStatus
+
+
+def run_checks(verbose: bool = False) -> list[CheckResult]:  # noqa: ARG001
+    """Run authentication diagnostic checks."""
+    results = []
+    results.append(_check_api_key_present())
+    results.append(_check_access_token_present())
+    results.append(_check_credentials_valid())
+    return results
+
+
+def _check_api_key_present() -> CheckResult:
+    """Check if an API key is configured."""
+    import os
+
+    api_key = os.environ.get("QBRAID_API_KEY")
+    if api_key:
+        return CheckResult(
+            name="auth.api_key_present",
+            category="auth",
+            status=CheckStatus.PASS,
+            message="API key found in QBRAID_API_KEY environment variable.",
+        )
+
+    try:
+        from qbraid_core.config import DEFAULT_CONFIG_SECTION, load_config
+
+        config = load_config()
+        section = DEFAULT_CONFIG_SECTION
+        if config.has_section(section):
+            # Check for exact "api-key" or any "api-key-*" named key
+            if config.has_option(section, "api-key"):
+                key = config.get(section, "api-key")
+                if key and key.strip():
+                    return CheckResult(
+                        name="auth.api_key_present",
+                        category="auth",
+                        status=CheckStatus.PASS,
+                        message="API key found in qbraidrc config file.",
+                    )
+
+            named_keys = [k for k in config.options(section) if k.startswith("api-key-")]
+            if named_keys:
+                return CheckResult(
+                    name="auth.api_key_present",
+                    category="auth",
+                    status=CheckStatus.PASS,
+                    message=(
+                        f"Found {len(named_keys)} named API key(s) in config:"
+                        f" {', '.join(named_keys)}"
+                    ),
+                )
+    except Exception:
+        pass
+
+    return CheckResult(
+        name="auth.api_key_present",
+        category="auth",
+        status=CheckStatus.FAIL,
+        message="No API key found.",
+        fix_hint="Run 'qbraid configure set api-key <YOUR_KEY>' or set QBRAID_API_KEY env var.",
+    )
+
+
+def _check_access_token_present() -> CheckResult:
+    """Check if an access token is configured."""
+    import os
+
+    token = os.environ.get("QBRAID_ACCESS_TOKEN")
+    if token:
+        return CheckResult(
+            name="auth.access_token_present",
+            category="auth",
+            status=CheckStatus.PASS,
+            message="Access token found in QBRAID_ACCESS_TOKEN environment variable.",
+        )
+
+    try:
+        from qbraid_core.config import DEFAULT_CONFIG_SECTION, load_config
+
+        config = load_config()
+        if config.has_option(DEFAULT_CONFIG_SECTION, "access-token"):
+            tok = config.get(DEFAULT_CONFIG_SECTION, "access-token")
+            if tok and tok.strip():
+                return CheckResult(
+                    name="auth.access_token_present",
+                    category="auth",
+                    status=CheckStatus.PASS,
+                    message="Access token found in qbraidrc config file.",
+                )
+    except Exception:
+        pass
+
+    return CheckResult(
+        name="auth.access_token_present",
+        category="auth",
+        status=CheckStatus.SKIP,
+        message="No access token configured (optional — API key is sufficient).",
+    )
+
+
+def _check_credentials_valid() -> CheckResult:
+    """Verify credentials by calling /users/verify."""
+    try:
+        from qbraid_core.sessions import QbraidSessionV1
+
+        session = QbraidSessionV1()
+
+        if not session.api_key and not session.access_token:
+            return CheckResult(
+                name="auth.credentials_valid",
+                category="auth",
+                status=CheckStatus.SKIP,
+                message="No credentials to validate.",
+            )
+
+        metadata = session.get_user_auth_metadata()
+        user_id = metadata.get("userId", "unknown")
+        org_id = metadata.get("organizationId", "unknown")
+        return CheckResult(
+            name="auth.credentials_valid",
+            category="auth",
+            status=CheckStatus.PASS,
+            message=f"Credentials valid. User: {user_id}, Org: {org_id}",
+            details={"userId": user_id, "organizationId": org_id},
+        )
+    except Exception as exc:
+        return CheckResult(
+            name="auth.credentials_valid",
+            category="auth",
+            status=CheckStatus.FAIL,
+            message=f"Credential validation failed: {exc}",
+            fix_hint="Check your API key is correct. Run 'qbraid configure set api-key <KEY>'.",
+        )

qbraid_core-0.3.0/qbraid_core/diagnostics/config.py

@@ -0,0 +1,144 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""Configuration diagnostic checks."""
+
+import os
+from pathlib import Path
+
+from .models import CheckResult, CheckStatus
+
+
+def run_checks(verbose: bool = False) -> list[CheckResult]:  # noqa: ARG001
+    """Run configuration diagnostic checks."""
+    results = []
+    results.append(_check_config_file_exists())
+    results.append(_check_config_parseable())
+    results.append(_check_config_url())
+    results.append(_check_config_dir_writable())
+    return results
+
+
+def _check_config_file_exists() -> CheckResult:
+    """Check if the qBraid config file exists."""
+    config_path = Path.home() / ".qbraid" / "qbraidrc"
+    if config_path.exists():
+        return CheckResult(
+            name="config.file_exists",
+            category="config",
+            status=CheckStatus.PASS,
+            message=f"Config file found at {config_path}",
+        )
+    return CheckResult(
+        name="config.file_exists",
+        category="config",
+        status=CheckStatus.WARN,
+        message=f"Config file not found at {config_path}",
+        fix_hint="Run 'qbraid configure set api-key <KEY>' to create it.",
+    )
+
+
+def _check_config_parseable() -> CheckResult:
+    """Check if the qBraid config file can be parsed."""
+    try:
+        from qbraid_core.config import load_config
+
+        config = load_config()
+        sections = config.sections()
+        return CheckResult(
+            name="config.parseable",
+            category="config",
+            status=CheckStatus.PASS,
+            message=f"Config file parsed successfully. Sections: {sections}",
+        )
+    except FileNotFoundError:
+        return CheckResult(
+            name="config.parseable",
+            category="config",
+            status=CheckStatus.SKIP,
+            message="Config file does not exist.",
+        )
+    except Exception as exc:
+        return CheckResult(
+            name="config.parseable",
+            category="config",
+            status=CheckStatus.FAIL,
+            message=f"Config file parse error: {exc}",
+            fix_hint="Check ~/.qbraid/qbraidrc for syntax errors. It uses INI format.",
+        )
+
+
+def _check_config_url() -> CheckResult:
+    """Check that the configured API URL looks valid."""
+    try:
+        from qbraid_core.config import (
+            DEFAULT_CONFIG_SECTION,
+            DEFAULT_ENDPOINT_URL,
+            load_config,
+        )
+
+        url = os.environ.get("QBRAID_API_URL")
+        source = "QBRAID_API_URL env var"
+
+        if not url:
+            try:
+                config = load_config()
+                if config.has_option(DEFAULT_CONFIG_SECTION, "url"):
+                    url = config.get(DEFAULT_CONFIG_SECTION, "url")
+                    source = "qbraidrc config"
+            except Exception:
+                pass
+
+        if not url:
+            url = DEFAULT_ENDPOINT_URL
+            source = "default"
+
+        if not url.startswith(("http://", "https://")):
+            return CheckResult(
+                name="config.api_url",
+                category="config",
+                status=CheckStatus.FAIL,
+                message=f"API URL is not a valid HTTP(S) URL: {url}",
+                fix_hint="Run 'qbraid configure set url https://...'",
+            )
+
+        return CheckResult(
+            name="config.api_url",
+            category="config",
+            status=CheckStatus.PASS,
+            message=f"API URL: {url} (source: {source})",
+        )
+    except Exception as exc:
+        return CheckResult(
+            name="config.api_url",
+            category="config",
+            status=CheckStatus.ERROR,
+            message=f"Could not check API URL: {exc}",
+        )
+
+
+def _check_config_dir_writable() -> CheckResult:
+    """Check that ~/.qbraid directory exists and is writable."""
+    qbraid_dir = Path.home() / ".qbraid"
+    if not qbraid_dir.exists():
+        return CheckResult(
+            name="config.dir_writable",
+            category="config",
+            status=CheckStatus.WARN,
+            message="~/.qbraid directory does not exist.",
+            fix_hint="It will be created automatically when you first configure qBraid.",
+        )
+    if not os.access(qbraid_dir, os.W_OK):
+        return CheckResult(
+            name="config.dir_writable",
+            category="config",
+            status=CheckStatus.FAIL,
+            message="~/.qbraid directory is not writable.",
+            fix_hint=f"Fix permissions: chmod 755 {qbraid_dir}",
+        )
+    return CheckResult(
+        name="config.dir_writable",
+        category="config",
+        status=CheckStatus.PASS,
+        message="~/.qbraid directory exists and is writable.",
+    )