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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openquantum-sdk
-Version: 0.3.3
+Version: 0.3.7
 Summary: Python SDK for Open Quantum
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
@@ -8,6 +8,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: requests>=2.25.0
+Provides-Extra: qiskit
+Requires-Dist: openquantum-sdk-qiskit>=0.2.4; extra == "qiskit"
+Provides-Extra: pennylane
+Requires-Dist: openquantum-sdk-pennylane>=0.1.0; extra == "pennylane"
 
 # Open Quantum Python SDK
 
@@ -58,6 +62,13 @@ auth = ClientCredentialsAuth(
 )
 ```
 
+### Option 3: Environment Variables
+
+```bash
+export OPENQUANTUM_CLIENT_ID=s_...
+export OPENQUANTUM_CLIENT_SECRET=e460c8...
+```
+
 ## Quickstart: One-Call Submission (Recommended)
 
 ```python
@@ -93,7 +104,7 @@ try:
     # 3. Define config
     config = JobSubmissionConfig(
         organization_id=org_id,
-        backend_class_id="rigetti:ankaa-3",
+        backend_class_id="iqm:emerald",
         name="Bell State SDK Quickstart",
         job_subcategory_id="fin:port", # Finance Portfolio Optimization
         shots=100,
@@ -155,7 +166,7 @@ try:
         print(f" - {bc.name} [{bc.type}] — {bc.short_code or bc.id}")
 
     # 2. Choose IDs
-    MY_BACKEND = "rigetti:ankaa-3"
+    MY_BACKEND = "iqm:emerald"
     MY_SUBCATEGORY = "fin:port"
 
     # 3. Upload
@@ -290,6 +301,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
 
@@ -345,7 +357,7 @@ from openquantum_sdk.enums import ExecutionPlanType, QueuePriorityType
 ```bash
 python -m openquantum_sdk --sdk-key ./key.json \
                           --input bell.qasm \
-                          --backend "ionq:aria-1" \
+                          --backend "iqm:emerald" \
                           --name "CLI Circuit" \
                           --subcategory "mathematics:linear-systems" \
                           --shots 100 \
@@ -359,11 +371,12 @@ Automatically **downloads and pretty-prints JSON output**.
 ### Backends 
 | Provider | Backend |  Short Code | 
 | ------ | ------ | ------ |
-| IonQ | Aria-1 | `ionq:aria-1` |
+| AQT | Ibex-Q1 | `aqt:ibex-q1` |
+| IonQ | Forte Enterprise | `ionq:forte-ent` |
 | IonQ | Forte-1 | `ionq:forte-1` |
 | IQM | Emerald | `iqm:emerald` |
 | IQM | Garnet | `iqm:garnet` | 
-| Rigetti | Ankaa-3 | `rigetti:ankaa-3` |
+| Rigetti | Cepheus-1-108Q | `rigetti:cepheus-108q`|
 
 *Note: This list may be modified as backends are added or removed from the platform. For the most up-to-date list, run the following code:*
 
@@ -431,5 +444,8 @@ for cat in cats:
 **Q: How do I get results as JSON?**  
 **A:** Use `scheduler.download_job_output(job)` — returns parsed object.
 
-**Q: Why does auto mode fail on some QPUs?**  
-**A:** `auto` only allows `PUBLIC` + `STANDARD`. Use explicit enums for private/instant access.
+**Q: Why does auto mode fail on some QPUs?**
+**A:** `"auto"` selects the cheapest plan and priority (`PUBLIC` + `STANDARD`). If a backend only offers private execution, pass `execution_plan="private"` explicitly. Similarly, use `queue_priority="priority"` or `"instant"` for higher-priority queue 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.7/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
@@ -93,7 +89,7 @@ try:
     # 3. Define config
     config = JobSubmissionConfig(
         organization_id=org_id,
-        backend_class_id="rigetti:ankaa-3",
+        backend_class_id="iqm:emerald",
         name="Bell State SDK Quickstart",
         job_subcategory_id="fin:port", # Finance Portfolio Optimization
         shots=100,
@@ -155,7 +151,7 @@ try:
         print(f" - {bc.name} [{bc.type}] — {bc.short_code or bc.id}")
 
     # 2. Choose IDs
-    MY_BACKEND = "rigetti:ankaa-3"
+    MY_BACKEND = "iqm:emerald"
     MY_SUBCATEGORY = "fin:port"
 
     # 3. Upload
@@ -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
 
@@ -345,7 +342,7 @@ from openquantum_sdk.enums import ExecutionPlanType, QueuePriorityType
 ```bash
 python -m openquantum_sdk --sdk-key ./key.json \
                           --input bell.qasm \
-                          --backend "ionq:aria-1" \
+                          --backend "iqm:emerald" \
                           --name "CLI Circuit" \
                           --subcategory "mathematics:linear-systems" \
                           --shots 100 \
@@ -359,11 +356,12 @@ Automatically **downloads and pretty-prints JSON output**.
 ### Backends 
 | Provider | Backend |  Short Code | 
 | ------ | ------ | ------ |
-| IonQ | Aria-1 | `ionq:aria-1` |
+| AQT | Ibex-Q1 | `aqt:ibex-q1` |
+| IonQ | Forte Enterprise | `ionq:forte-ent` |
 | IonQ | Forte-1 | `ionq:forte-1` |
 | IQM | Emerald | `iqm:emerald` |
 | IQM | Garnet | `iqm:garnet` | 
-| Rigetti | Ankaa-3 | `rigetti:ankaa-3` |
+| Rigetti | Cepheus-1-108Q | `rigetti:cepheus-108q`|
 
 *Note: This list may be modified as backends are added or removed from the platform. For the most up-to-date list, run the following code:*
 
@@ -431,5 +429,8 @@ for cat in cats:
 **Q: How do I get results as JSON?**  
 **A:** Use `scheduler.download_job_output(job)` — returns parsed object.
 
-**Q: Why does auto mode fail on some QPUs?**  
-**A:** `auto` only allows `PUBLIC` + `STANDARD`. Use explicit enums for private/instant access.
+**Q: Why does auto mode fail on some QPUs?**
+**A:** `"auto"` selects the cheapest plan and priority (`PUBLIC` + `STANDARD`). If a backend only offers private execution, pass `execution_plan="private"` explicitly. Similarly, use `queue_priority="priority"` or `"instant"` for higher-priority queue 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.7}/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.7"
 __all__ = ["SchedulerClient", "ManagementClient", "poll_for_status"]

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.7}/openquantum_sdk/__main__.py

@@ -121,8 +121,10 @@ def main():
         creds=creds
     )
 
-    scheduler = SchedulerClient(base_url=args.scheduler_base, auth=auth)
     management = ManagementClient(base_url=args.management_base, auth=auth)
+    scheduler = SchedulerClient(
+        base_url=args.scheduler_base, auth=auth, management_client=management
+    )
 
     try:
         print("--- Open Quantum Job Submission CLI ---")

{openquantum_sdk-0.3.3 → openquantum_sdk-0.3.7}/openquantum_sdk/auth.py

@@ -9,17 +9,28 @@ from urllib.parse import urljoin
 
 @dataclass
 class ClientCredentials:
+    """SDK key credentials for machine-to-machine authentication.
+
+    Attributes:
+        client_id: The OAuth2 client ID (SDK key ID).
+        client_secret: The OAuth2 client secret (SDK key secret).
+    """
+
     client_id: str
     client_secret: str
 
 
 class ClientCredentialsAuth:
+    """Keycloak client-credentials OAuth2 helper with thread-safe token caching.
+
+    Manages the full token lifecycle: initial fetch, automatic refresh when
+    the token is within ``leeway_seconds`` of expiry, and forced refresh on
+    401 retries. All token operations are thread-safe.
+
+    The token endpoint is constructed as:
+    ``{keycloak_base}/realms/{realm}/protocol/openid-connect/token``
     """
-    Keycloak client-credentials OAuth2 helper with local, thread-safe token cache.
-    - Fetches token from: {keycloak_base}/realms/{realm}/protocol/openid-connect/token
-    - Auto refreshes when within leeway of expiry
-    - Retries once on 401
-    """
+
     def __init__(
         self,
         creds: ClientCredentials,
@@ -29,6 +40,19 @@ class ClientCredentialsAuth:
         leeway_seconds: int = 30,
         session: Optional[requests.Session] = None,
     ):
+        """Initialize the auth helper.
+
+        Args:
+            creds: Client credentials containing the client ID and secret.
+            keycloak_base: Base URL of the Keycloak server.
+                Defaults to ``"https://id.openquantum.com"``.
+            realm: Keycloak realm name. Defaults to ``"platform"``.
+            scope: Optional OAuth2 scope to request.
+            leeway_seconds: Seconds before token expiry to trigger a
+                proactive refresh. Defaults to 30.
+            session: Optional ``requests.Session`` to use for token requests.
+                A new session is created if not provided.
+        """
         self.keycloak_base = keycloak_base.rstrip("/")
         self.realm = realm
         self.creds = creds
@@ -41,6 +65,7 @@ class ClientCredentialsAuth:
 
     @property
     def token_endpoint(self) -> str:
+        """The full Keycloak token endpoint URL for this realm."""
         return urljoin(
             self.keycloak_base + "/",
             f"realms/{self.realm}/protocol/openid-connect/token",
@@ -72,6 +97,22 @@ class ClientCredentialsAuth:
         self._expires_at = time.time() + int(expires_in)
 
     def get_access_token(self, force: bool = False) -> str:
+        """Return a valid access token, refreshing if needed.
+
+        Uses double-checked locking to ensure only one thread fetches a
+        new token at a time.
+
+        Args:
+            force: If ``True``, forces a token refresh regardless of
+                expiry status. Defaults to ``False``.
+
+        Returns:
+            A valid OAuth2 access token string.
+
+        Raises:
+            RuntimeError: If the Keycloak response is missing an access token.
+            requests.HTTPError: If the token request fails.
+        """
         if force or self._needs_refresh():
             with self._lock:
                 if force or self._needs_refresh():
@@ -79,6 +120,18 @@ class ClientCredentialsAuth:
         return self._access_token  # type: ignore[str-bytes-safe]
 
     def apply_auth_header(self, headers: Dict[str, str]) -> Dict[str, str]:
+        """Add a Bearer authorization header using the current access token.
+
+        Does not mutate the input dict; returns a new dict with the
+        ``Authorization`` header added.
+
+        Args:
+            headers: Existing headers to augment.
+
+        Returns:
+            A new headers dict containing all entries from ``headers`` plus
+            the ``Authorization: Bearer <token>`` header.
+        """
         token = self.get_access_token()
         # don't mutate caller's header dict
         return {**headers, "Authorization": f"Bearer {token}"}