subspacecomputing 0.1.0__tar.gz → 0.1.2__tar.gz

{subspacecomputing-0.1.0/subspacecomputing.egg-info → subspacecomputing-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subspacecomputing
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python SDK for Subspace Computing Engine API (by Beausoft)
 Home-page: https://www.subspacecomputing.com/developer
 Author: Beausoft
@@ -49,6 +49,17 @@ bsce = BSCE(api_key='your-api-key-here')
 # bsce = BSCE(api_key='your-api-key-here', base_url='http://localhost:8000')
 ```
 
+### Teams (`X-Team-Id`)
+
+Keys can carry a `default_team_id` from the portal. If the user is in **several** teams, some endpoints require an explicit team: pass `team_id=...` or call `set_team_id` so the SDK sends `X-Team-Id`.
+
+If you omit it when required, the API returns **400** with `error.reason` **`team_context_required`**. Use `ValidationError` and read `exc.reason`.
+
+```python
+bsce = BSCE(api_key="...", team_id="00000000-0000-0000-0000-000000000000")
+bsce.set_team_id(None)  # clear override for following requests
+```
+
 ### Simple Projection (1 scenario)
 
 ```python
@@ -245,7 +256,7 @@ if quota:
 
 Check out the full documentation at https://www.subspacecomputing.com/developer
 
-API reference is available at https://api.subspacecomputing.com/docs
+API reference is available at https://www.subspacecomputing.com/docs
 
 For support, reach out to contact@beausoft.ca
 

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/README.md

@@ -22,6 +22,17 @@ bsce = BSCE(api_key='your-api-key-here')
 # bsce = BSCE(api_key='your-api-key-here', base_url='http://localhost:8000')
 ```
 
+### Teams (`X-Team-Id`)
+
+Keys can carry a `default_team_id` from the portal. If the user is in **several** teams, some endpoints require an explicit team: pass `team_id=...` or call `set_team_id` so the SDK sends `X-Team-Id`.
+
+If you omit it when required, the API returns **400** with `error.reason` **`team_context_required`**. Use `ValidationError` and read `exc.reason`.
+
+```python
+bsce = BSCE(api_key="...", team_id="00000000-0000-0000-0000-000000000000")
+bsce.set_team_id(None)  # clear override for following requests
+```
+
 ### Simple Projection (1 scenario)
 
 ```python
@@ -218,7 +229,7 @@ if quota:
 
 Check out the full documentation at https://www.subspacecomputing.com/developer
 
-API reference is available at https://api.subspacecomputing.com/docs
+API reference is available at https://www.subspacecomputing.com/docs
 
 For support, reach out to contact@beausoft.ca
 

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "subspacecomputing"
-version = "0.1.0"
+version = "0.1.2"
 description = "Python SDK for Subspace Computing Engine API (by Beausoft)"
 authors = [{name = "Beausoft", email = "contact@beausoft.ca"}]
 readme = "README.md"
@@ -25,6 +25,7 @@ dev = [
     "fastapi>=0.100.0",  # Pour tests d'intégration
 ]
 
+# No Git repository URL: built from a private monorepo; only public product URLs are published on PyPI.
 [project.urls]
 Documentation = "https://www.subspacecomputing.com/developer"
 Homepage = "https://www.subspacecomputing.com/developer"

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/setup.py

@@ -13,7 +13,7 @@ except FileNotFoundError:
 
 setup(
     name="subspacecomputing",
-    version="0.1.0",
+    version="0.1.2",
     description="Python SDK for Subspace Computing Engine API (by Beausoft)",
     long_description=long_description,
     long_description_content_type="text/markdown",

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/subspacecomputing/__init__.py

@@ -13,7 +13,7 @@ from .errors import (
     ValidationError,
 )
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"
 __all__ = [
     "BSCE",
     "BSCEError",

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/subspacecomputing/client.py

@@ -26,6 +26,8 @@ class BSCE:
         api_key: str,
         base_url: Optional[str] = None,
         timeout: Optional[int] = None,
+        *,
+        team_id: Optional[str] = None,
     ):
         """
         Initialize the BSCE client.
@@ -36,6 +38,7 @@ class BSCE:
             base_url: API base URL (optional, defaults to https://api.subspacecomputing.com).
                      Only useful for local testing or custom environments.
             timeout: Request timeout in seconds (optional, defaults to 60).
+            team_id: Optional team UUID for header ``X-Team-Id`` (override default_team_id on the key).
 
         Raises:
             ValueError: If api_key is empty or None.
@@ -47,13 +50,25 @@ class BSCE:
         self.api_key = api_key.strip()
         self.base_url = (base_url or "https://api.subspacecomputing.com").rstrip("/")
         self.timeout = timeout if timeout is not None else DEFAULT_TIMEOUT
+        self._team_id = (team_id or "").strip() or None
         self.session = requests.Session()
-        self.session.headers.update({
+        headers = {
             "X-API-Key": self.api_key,
             "Content-Type": "application/json",
-        })
+        }
+        if self._team_id:
+            headers["X-Team-Id"] = self._team_id
+        self.session.headers.update(headers)
         self.last_response = None  # Store last response for header access
 
+    def set_team_id(self, team_id: Optional[str] = None) -> None:
+        """Set or clear ``X-Team-Id`` for subsequent requests."""
+        self._team_id = (team_id or "").strip() or None
+        if self._team_id:
+            self.session.headers["X-Team-Id"] = self._team_id
+        else:
+            self.session.headers.pop("X-Team-Id", None)
+
     def _handle_response(self, response: requests.Response):
         """
         Handle HTTP errors and raise appropriate exceptions.
@@ -140,15 +155,15 @@ class BSCE:
         scenario_id: int,
     ) -> Dict[str, Any]:
         """
-        Rejoue un scénario spécifique d'une simulation précédente.
+        Replay a specific scenario from a previous simulation.
 
         Args:
-            original_spec: SP Model complet de la simulation initiale
-            original_seeds: Objet seeds de la réponse de simulate() (seeds.global, seeds.scenarios)
-            scenario_id: Index du scénario à rejouer (0 à scenarios-1)
+            original_spec: Full SP Model from the initial simulation
+            original_seeds: Seeds object from simulate() response (seeds.global, seeds.scenarios)
+            scenario_id: Index of the scenario to replay (0 to scenarios-1)
 
         Returns:
-            Réponse simulate pour ce scénario unique (final_values, sample_path_s0, etc.)
+            Simulate response for this single scenario (final_values, sample_path_s0, etc.)
 
         Example:
             result = client.simulate(spec)
@@ -401,23 +416,24 @@ class BSCE:
 
     def replay_run(self, run_id: str, scenario_id: int) -> Dict[str, Any]:
         """
-        Rejoue un scénario à partir d'une run stockée (nécessite seeds persistés).
+        Replay a scenario from a stored run (requires persisted seeds).
 
         Args:
-            run_id: ID de la run (créée avec meta.store_seeds_for_replay: true)
-            scenario_id: Index du scénario à rejouer (0 à scenarios-1)
+            run_id: Run ID (created with meta.store_seeds_for_replay: true)
+            scenario_id: Index of the scenario to replay (0 to scenarios-1)
 
         Returns:
-            Réponse simulate pour ce scénario unique (final_values, sample_path_s0, etc.)
+            Simulate response for this single scenario (final_values, sample_path_s0, etc.)
 
         Raises:
-            ValidationError: Si seeds non stockés ou scenario_id hors limites
-            AuthenticationError: Si clé API invalide
+            ValidationError: If seeds not stored or scenario_id out of range
+            AuthenticationError: If API key invalid
 
         Example:
-            result = client.simulate(spec)  # avec store_seeds_for_replay: true
+            result = client.simulate(spec)  # with store_seeds_for_replay: true
             replay = client.replay_run(result["run_id"], scenario_id=12)
         """
+        # API expects run_id and scenario_id in URL path; no request body required
         response = self.session.post(
             f"{self.base_url}/projection-runs/{run_id}/replay/{scenario_id}",
             timeout=self.timeout,
@@ -444,8 +460,39 @@ class BSCE:
         self._handle_response(response)
         # 204 No Content, no body
 
+    def get_run_artifact(self, artifact_id: str) -> Dict[str, Any]:
+        """
+        Fetch a run artifact by id (authZ: view on parent projection).
+
+        Args:
+            artifact_id: run_artifacts.id
+
+        Returns:
+            Artifact payload (may include final_values or url).
+        """
+        response = self.session.get(
+            f"{self.base_url}/run-artifacts/{artifact_id}",
+            timeout=self.timeout,
+        )
+        self.last_response = response
+        self._handle_response(response)
+        return response.json()
+
     # Helper methods for accessing rate limit and quota info
 
+    @staticmethod
+    def _safe_int(val: Optional[str]) -> Optional[int]:
+        """
+        Safely convert a header value to int.
+        Returns None for None, 'unlimited', or non-numeric strings.
+        """
+        if val is None or val == "unlimited":
+            return None
+        try:
+            return int(val)
+        except (ValueError, TypeError):
+            return None
+
     def get_rate_limit_info(self) -> Optional[Dict[str, Any]]:
         """
         Get rate limit information from the last response.
@@ -460,8 +507,8 @@ class BSCE:
         if limit is None and remaining is None:
             return None
         return {
-            "limit": int(limit) if limit else None,
-            "remaining": int(remaining) if remaining else None,
+            "limit": self._safe_int(limit),
+            "remaining": self._safe_int(remaining),
         }
 
     def get_quota_info(self) -> Optional[Dict[str, Any]]:
@@ -479,7 +526,7 @@ class BSCE:
         if limit is None and remaining is None and used is None:
             return None
         return {
-            "limit": int(limit) if limit and limit != "unlimited" else None,
-            "remaining": int(remaining) if remaining else None,
-            "used": int(used) if used else None,
+            "limit": self._safe_int(limit),
+            "remaining": self._safe_int(remaining),
+            "used": self._safe_int(used),
         }

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/subspacecomputing/errors.py

@@ -3,7 +3,7 @@ Custom exceptions for the Subspace Computing SDK.
 """
 
 import requests
-from typing import Optional
+from typing import Any, Optional
 
 
 class BSCEError(Exception):
@@ -13,19 +13,31 @@ class BSCEError(Exception):
         self.message = message
         self.response = response
         self.status_code = response.status_code if response else None
-        self.detail = None
+        self.detail: Any = None
+        self._body: Optional[dict] = None
 
-        # Try to extract error details from the response
         if response is not None:
             try:
                 error_data = response.json()
                 if isinstance(error_data, dict):
+                    self._body = error_data
                     self.detail = error_data.get("detail", error_data.get("message"))
-            except (ValueError, KeyError):
+            except ValueError:
                 self.detail = response.text
 
         super().__init__(self.message)
 
+    @property
+    def reason(self) -> Optional[str]:
+        """Clé stable contrat §6.8 si le corps est ``{\"error\": {\"reason\": ...}}``."""
+        if not self._body:
+            return None
+        err = self._body.get("error")
+        if isinstance(err, dict):
+            r = err.get("reason")
+            return str(r) if r is not None else None
+        return None
+
     def __str__(self):
         if self.detail:
             return f"{self.message}: {self.detail}"

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/subspacecomputing/utils/pandas_integration.py

@@ -14,7 +14,7 @@ def batch_response_to_dataframe(response: dict):
     import pandas as pd
 
     rows = []
-    for entity in response.get("entities", []):
+    for entity in response.get("entities") or []:
         row = {"entity_id": entity.get("_entity_id", "")}
         fv = entity.get("final_values", {})
         for k, v in fv.items():

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2/subspacecomputing.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subspacecomputing
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python SDK for Subspace Computing Engine API (by Beausoft)
 Home-page: https://www.subspacecomputing.com/developer
 Author: Beausoft
@@ -49,6 +49,17 @@ bsce = BSCE(api_key='your-api-key-here')
 # bsce = BSCE(api_key='your-api-key-here', base_url='http://localhost:8000')
 ```
 
+### Teams (`X-Team-Id`)
+
+Keys can carry a `default_team_id` from the portal. If the user is in **several** teams, some endpoints require an explicit team: pass `team_id=...` or call `set_team_id` so the SDK sends `X-Team-Id`.
+
+If you omit it when required, the API returns **400** with `error.reason` **`team_context_required`**. Use `ValidationError` and read `exc.reason`.
+
+```python
+bsce = BSCE(api_key="...", team_id="00000000-0000-0000-0000-000000000000")
+bsce.set_team_id(None)  # clear override for following requests
+```
+
 ### Simple Projection (1 scenario)
 
 ```python
@@ -245,7 +256,7 @@ if quota:
 
 Check out the full documentation at https://www.subspacecomputing.com/developer
 
-API reference is available at https://api.subspacecomputing.com/docs
+API reference is available at https://www.subspacecomputing.com/docs
 
 For support, reach out to contact@beausoft.ca
 

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/subspacecomputing.egg-info/SOURCES.txt

@@ -14,4 +14,5 @@ subspacecomputing.egg-info/top_level.txt
 subspacecomputing/utils/__init__.py
 subspacecomputing/utils/pandas_integration.py
 tests/test_client_integration.py
-tests/test_client_unit.py
+tests/test_client_unit.py
+tests/test_pandas_integration.py

{subspacecomputing-0.1.0 → subspacecomputing-0.1.2}/tests/test_client_unit.py

@@ -331,3 +331,50 @@ class TestBatchParameters:
             assert 'aggregations' in call_args[1]['json']
             assert result['aggregations']['capital_total'] == 3000.0
 
+
+class TestRateLimitQuotaInfo:
+    """Tests for get_rate_limit_info and get_quota_info with _safe_int."""
+
+    def test_get_rate_limit_info_unlimited(self, api_key, base_url):
+        """get_rate_limit_info handles 'unlimited' without crashing."""
+        bsce = BSCE(api_key=api_key, base_url=base_url)
+        mock_response = Mock()
+        mock_response.headers = {"X-RateLimit-Limit": "unlimited", "X-RateLimit-Remaining": "999"}
+        bsce.last_response = mock_response
+
+        result = bsce.get_rate_limit_info()
+        assert result["limit"] is None
+        assert result["remaining"] == 999
+
+    def test_get_quota_info_unlimited(self, api_key, base_url):
+        """get_quota_info handles 'unlimited' in X-Quota-Limit."""
+        bsce = BSCE(api_key=api_key, base_url=base_url)
+        mock_response = Mock()
+        mock_response.headers = {
+            "X-Quota-Limit": "unlimited",
+            "X-Quota-Remaining": "100",
+            "X-Quota-Used": "50",
+        }
+        bsce.last_response = mock_response
+
+        result = bsce.get_quota_info()
+        assert result["limit"] is None
+        assert result["remaining"] == 100
+        assert result["used"] == 50
+
+    def test_get_quota_info_invalid_values(self, api_key, base_url):
+        """get_quota_info handles non-numeric values gracefully."""
+        bsce = BSCE(api_key=api_key, base_url=base_url)
+        mock_response = Mock()
+        mock_response.headers = {
+            "X-Quota-Limit": "N/A",
+            "X-Quota-Remaining": "remaining",
+            "X-Quota-Used": "50",
+        }
+        bsce.last_response = mock_response
+
+        result = bsce.get_quota_info()
+        assert result["limit"] is None
+        assert result["remaining"] is None
+        assert result["used"] == 50
+

subspacecomputing-0.1.2/tests/test_pandas_integration.py

@@ -0,0 +1,41 @@
+"""
+Unit tests for pandas integration utilities.
+"""
+
+import pytest
+
+pandas = pytest.importorskip("pandas")
+
+from subspacecomputing.utils.pandas_integration import batch_response_to_dataframe
+
+
+class TestBatchResponseToDataframe:
+    """Tests for batch_response_to_dataframe."""
+
+    def test_entities_null_does_not_crash(self):
+        """batch_response_to_dataframe handles entities=null without TypeError."""
+        response = {"entities": None, "aggregations": {}, "summary": {}}
+        df = batch_response_to_dataframe(response)
+        assert len(df) == 0
+
+    def test_entities_missing_uses_empty_list(self):
+        """batch_response_to_dataframe handles missing entities key."""
+        response = {"aggregations": {}, "summary": {}}
+        df = batch_response_to_dataframe(response)
+        assert len(df) == 0
+
+    def test_entities_normal(self):
+        """batch_response_to_dataframe converts entities to DataFrame."""
+        response = {
+            "entities": [
+                {"_entity_id": "e1", "final_values": {"capital": 1000, "taux": 0.05}},
+                {"_entity_id": "e2", "final_values": {"capital": 2000, "taux": 0.06}},
+            ],
+            "aggregations": {},
+            "summary": {},
+        }
+        df = batch_response_to_dataframe(response)
+        assert len(df) == 2
+        assert list(df.columns) == ["entity_id", "capital", "taux"]
+        assert df["entity_id"].tolist() == ["e1", "e2"]
+        assert df["capital"].tolist() == [1000, 2000]