openquantum-sdk 0.3.3__tar.gz → 0.3.4__tar.gz

{openquantum_sdk-0.3.3/openquantum_sdk.egg-info → openquantum_sdk-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openquantum-sdk
-Version: 0.3.3
+Version: 0.3.4
 Summary: Python SDK for Open Quantum
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
@@ -58,6 +58,13 @@ auth = ClientCredentialsAuth(
 )
 ```
 
+### Option 3: Environment Variables
+
+```bash
+export OPENQUANTUM_CLIENT_ID=s_...
+export OPENQUANTUM_CLIENT_SECRET=e460c8...
+```
+
 ## Quickstart: One-Call Submission (Recommended)
 
 ```python
@@ -290,6 +297,7 @@ finally:
 | `list_user_organizations(limit=20, cursor=...)` | `PaginatedOrganizations` | Your orgs |
 | `list_providers(limit=20, cursor=...)` | `PaginatedProviders` | All backend providers |
 | `list_backend_classes(provider_id=None, limit=20, cursor=...)` | `PaginatedBackendClasses` | Available backends |
+| `get_credit_balance(organization_id: str)` | `CreditBalanceRead` | Get current credit balance |
 
 ## Data Models
 
@@ -433,3 +441,6 @@ for cat in cats:
 
 **Q: Why does auto mode fail on some QPUs?**  
 **A:** `auto` only allows `PUBLIC` + `STANDARD`. Use explicit enums for private/instant access.
+
+**Q: Can I hide the public plan citation notice?**  
+**A:** Setting `OPENQUANTUM_HIDE_CITATION_NOTICE=true` will omit the citation notice from output.

openquantum_sdk-0.3.3/PKG-INFO → openquantum_sdk-0.3.4/README.md

@@ -1,14 +1,3 @@
-Metadata-Version: 2.4
-Name: openquantum-sdk
-Version: 0.3.3
-Summary: Python SDK for Open Quantum
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: requests>=2.25.0
-
 # Open Quantum Python SDK
 
 A lightweight, modern Python SDK for the **Open Quantum Platform**.
@@ -58,6 +47,13 @@ auth = ClientCredentialsAuth(
 )
 ```
 
+### Option 3: Environment Variables
+
+```bash
+export OPENQUANTUM_CLIENT_ID=s_...
+export OPENQUANTUM_CLIENT_SECRET=e460c8...
+```
+
 ## Quickstart: One-Call Submission (Recommended)
 
 ```python
@@ -290,6 +286,7 @@ finally:
 | `list_user_organizations(limit=20, cursor=...)` | `PaginatedOrganizations` | Your orgs |
 | `list_providers(limit=20, cursor=...)` | `PaginatedProviders` | All backend providers |
 | `list_backend_classes(provider_id=None, limit=20, cursor=...)` | `PaginatedBackendClasses` | Available backends |
+| `get_credit_balance(organization_id: str)` | `CreditBalanceRead` | Get current credit balance |
 
 ## Data Models
 
@@ -433,3 +430,6 @@ for cat in cats:
 
 **Q: Why does auto mode fail on some QPUs?**  
 **A:** `auto` only allows `PUBLIC` + `STANDARD`. Use explicit enums for private/instant access.
+
+**Q: Can I hide the public plan citation notice?**  
+**A:** Setting `OPENQUANTUM_HIDE_CITATION_NOTICE=true` will omit the citation notice from output.

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.4}/openquantum_sdk/__init__.py

@@ -1,5 +1,5 @@
 from .clients import SchedulerClient, ManagementClient
 from .utils import poll_for_status
 
-__version__ = "0.3.3"
+__version__ = "0.3.4"
 __all__ = ["SchedulerClient", "ManagementClient", "poll_for_status"]

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.4}/openquantum_sdk/clients.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass, asdict
 import sys
+import os
 from typing import Optional, Dict, Any, List, Union, Tuple
 from urllib.parse import urljoin
 import requests
@@ -10,6 +11,7 @@ from .enums import AutoChoice, ExecutionPlanType, QueuePriorityType
 from .models import (
     APIError,
     BackendClassRead,
+    CreditBalanceRead,
     ErrorResponse,
     JobCategoryRead,
     JobCreate,
@@ -179,6 +181,10 @@ class ManagementClient(BaseClient):
         pagination = PaginationInfo.from_dict(data.get("pagination", {}))
         return PaginatedProviders(providers=providers, pagination=pagination)
 
+    def get_credit_balance(self, organization_id: str) -> CreditBalanceRead:
+        data = self._request("GET", f"/v1/organizations/{organization_id}/transactions/balance")
+        return CreditBalanceRead.from_dict(data)
+
 
 # ---------------------------------------------------------------------------
 #  Scheduler Client
@@ -193,6 +199,7 @@ class SchedulerClient(BaseClient):
     ):
         super().__init__(base_url, token=token, auth=auth)
         self.management = management_client or ManagementClient(auth=self._auth)
+        self._public_plan_notice_shown = False
 
     def get_job_categories(
         self, limit: int = 20, cursor: Optional[str] = None
@@ -309,6 +316,19 @@ class SchedulerClient(BaseClient):
         )
 
     def create_job(self, job: JobCreate) -> JobRead:
+        hide_notice = os.getenv("OPENQUANTUM_HIDE_CITATION_NOTICE", "").lower() in ("1", "true", "yes")
+        if (
+            job.execution_plan_id == ExecutionPlanType.PUBLIC.value
+            and not self._public_plan_notice_shown
+            and not hide_notice
+        ):
+            print(
+                "\nNote: You have selected the Public Plan. Any publications or public work "
+                "resulting from this job must provide proper attribution to Open Quantum. "
+                "Citation guidelines can be found at www.openquantum.com/citation.\n"
+            )
+            self._public_plan_notice_shown = True
+
         data = self._request("POST", "/v1/jobs", json=asdict(job))
         return JobRead.from_dict(data)
 

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.4}/openquantum_sdk/models.py

@@ -103,6 +103,13 @@ class PaginatedBackendClasses:
     extra: Dict[str, Any] = field(default_factory=dict, repr=False)
 
 
+@dataclass
+class CreditBalanceRead(FlexibleDataclass):
+    spark_credits: float
+    full_credits: float
+    extra: Dict[str, Any] = field(default_factory=dict, repr=False)
+
+
 # ---------------------------------------------------------------------------
 #  Scheduler API models
 # ---------------------------------------------------------------------------

openquantum_sdk-0.3.3/README.md → openquantum_sdk-0.3.4/openquantum_sdk.egg-info/PKG-INFO

@@ -1,3 +1,14 @@
+Metadata-Version: 2.4
+Name: openquantum-sdk
+Version: 0.3.4
+Summary: Python SDK for Open Quantum
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+
 # Open Quantum Python SDK
 
 A lightweight, modern Python SDK for the **Open Quantum Platform**.
@@ -47,6 +58,13 @@ auth = ClientCredentialsAuth(
 )
 ```
 
+### Option 3: Environment Variables
+
+```bash
+export OPENQUANTUM_CLIENT_ID=s_...
+export OPENQUANTUM_CLIENT_SECRET=e460c8...
+```
+
 ## Quickstart: One-Call Submission (Recommended)
 
 ```python
@@ -279,6 +297,7 @@ finally:
 | `list_user_organizations(limit=20, cursor=...)` | `PaginatedOrganizations` | Your orgs |
 | `list_providers(limit=20, cursor=...)` | `PaginatedProviders` | All backend providers |
 | `list_backend_classes(provider_id=None, limit=20, cursor=...)` | `PaginatedBackendClasses` | Available backends |
+| `get_credit_balance(organization_id: str)` | `CreditBalanceRead` | Get current credit balance |
 
 ## Data Models
 
@@ -422,3 +441,6 @@ for cat in cats:
 
 **Q: Why does auto mode fail on some QPUs?**  
 **A:** `auto` only allows `PUBLIC` + `STANDARD`. Use explicit enums for private/instant access.
+
+**Q: Can I hide the public plan citation notice?**  
+**A:** Setting `OPENQUANTUM_HIDE_CITATION_NOTICE=true` will omit the citation notice from output.

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "openquantum-sdk"
-version = "0.3.3"
+version = "0.3.4"
 description = "Python SDK for Open Quantum"
 readme = "README.md"
 requires-python = ">=3.8"

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.4}/tests/test_clients.py

@@ -343,6 +343,16 @@ def test_list_user_organizations_pagination(mock_management):
     assert result.pagination.next_cursor == "cursor-xyz"
 
 
+def test_get_credit_balance(mock_management):
+    mock_management.session.mocker.get(
+        "https://management.openquantum.com/v1/organizations/org-123/transactions/balance",
+        json={"spark_credits": 100.5, "full_credits": 50.0},
+    )
+    result = mock_management.get_credit_balance("org-123")
+    assert result.spark_credits == 100.5
+    assert result.full_credits == 50.0
+
+
 # ---------------------------------------------------------------------------
 # High-level submit_job tests (all pass unchanged)
 # ---------------------------------------------------------------------------
@@ -379,10 +389,10 @@ def test_download_job_output_success(mock_scheduler):
     job = mock_scheduler.get_job("job-123")
     mock_scheduler.session.mocker.get(
         "https://output.example.com/result-123",
-        text='{"histogram": {"00": 512, "11": 512}}',
+        text='{"00": 512, "11": 512}',
     )
     output = mock_scheduler.download_job_output(job)
-    assert output["histogram"]["00"] == 512
+    assert output["00"] == 512
 
 
 def test_download_job_output_no_url(mock_scheduler):