simulacrum-sdk 0.2.2__tar.gz → 0.2.3__tar.gz

{simulacrum_sdk-0.2.2/simulacrum_sdk.egg-info → simulacrum_sdk-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulacrum-sdk
-Version: 0.2.2
+Version: 0.2.3
 Summary: Official Python SDK for accessing the Simulacrum API.
 Author-email: "Simulacrum, Inc." <support@smlcrm.com>
 License-Expression: MIT

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simulacrum-sdk"
-version = "0.2.2"
+version = "0.2.3"
 description = "Official Python SDK for accessing the Simulacrum API."
 readme = "README.md"
 requires-python = ">=3.8"

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3}/simulacrum/client.py

@@ -41,7 +41,7 @@ class Simulacrum:
         }
 
     def forecast(
-        self, series: Sequence[float] | np.ndarray, horizon: int, model: str = "default"
+        self, series: Sequence[float] | np.ndarray, horizon: int | None = None, model: str = "default"
     ) -> np.ndarray:
         """Request a forecast for the provided time series.
 
@@ -86,6 +86,8 @@ class Simulacrum:
             series=series_to_send, horizon=horizon, model=model
         )
         request_body: Dict[str, Any] = payload.model_dump()
+        # Exclude optional fields that are None (e.g., horizon for onsiteiq)
+        request_body = payload.model_dump(exclude_none=True)
         response_data: Dict[str, Any] = send_request(
             method="POST",
             url=f"{self.base_url}/{model}/v1/forecast",

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3}/simulacrum/models.py

@@ -12,7 +12,7 @@ class ForecastRequest(BaseModel):
 
     Attributes:
         series (list[float]): Historical observations used as forecast input.
-        horizon (int): Number of future periods to predict.
+        horizon (int | None): Number of future periods to predict. Optional for the ``"onsiteiq"`` model.
         model (str | None): Identifier of the forecasting model, defaults to ``"default"``.
 
     Example:
@@ -23,7 +23,7 @@ class ForecastRequest(BaseModel):
     """
 
     series: List[float]
-    horizon: int
+    horizon: Optional[int] = None
     model: Optional[str] = "default"
 
     @field_validator("series", mode="before")
@@ -41,6 +41,23 @@ class ForecastRequest(BaseModel):
             return value.astype(float).tolist()
         return list(value)
 
+    @model_validator(mode="after")
+    def _validate_horizon_requirement(self):
+        # Horizon is required for all models except onsiteiq
+        model_name = (self.model or "").lower()
+        if model_name != "onsiteiq" and self.horizon is None:
+            raise ValueError("horizon is required and must be a positive integer for this model")
+
+        # When provided, horizon must be an integer >= 1
+        if self.horizon is not None:
+            if not isinstance(self.horizon, int):
+                raise ValueError(
+                    f"horizon must be an integer (got {type(self.horizon).__name__})"
+                )
+            if self.horizon < 1:
+                raise ValueError("horizon must be >= 1")
+        return self
+
 
 class ForecastResponse(BaseModel):
     """Forecast output returned by the API.

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3/simulacrum_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulacrum-sdk
-Version: 0.2.2
+Version: 0.2.3
 Summary: Official Python SDK for accessing the Simulacrum API.
 Author-email: "Simulacrum, Inc." <support@smlcrm.com>
 License-Expression: MIT

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3}/tests/test_client.py

@@ -1,4 +1,8 @@
 import os
+import sys
+
+# Ensure package import works when running tests directly
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 import pytest
 import numpy as np
 
@@ -9,12 +13,13 @@ import simulacrum.client as simulacrum_client
 
 @pytest.fixture
 def client():
-    base_url = os.environ.get("TEST_API")
-    return simulacrum_client.Simulacrum(os.environ.get("TEST_API_KEY"), base_url=base_url)
+    base_url = os.environ["TEST_API"]
+    api_key = os.environ["TEST_KEY"]
+    return simulacrum_client.Simulacrum(api_key, base_url=base_url)
 
 
 def test_client_initializes_expected_headers(client):
-    assert client.headers["Authorization"] == f"Bearer {os.environ.get('TEST_API_KEY')}"
+    assert client.headers["Authorization"] == f"Bearer {client.api_key}"
     assert client.headers["Content-Type"] == "application/json"
 
 
@@ -57,7 +62,7 @@ def test_forecast_builds_payload_and_returns_numpy_array(client, monkeypatch):
             captured_payload["horizon"] = horizon
             captured_payload["model"] = model
 
-        def model_dump(self):
+        def model_dump(self, *args, **kwargs):
             return {
                 "series": captured_payload["series"],
                 "horizon": captured_payload["horizon"],
@@ -85,7 +90,7 @@ def test_forecast_builds_payload_and_returns_numpy_array(client, monkeypatch):
     assert captured_payload["horizon"] == 2
     assert captured_payload["model"] == "prophet"
     assert captured_payload["method"] == "POST"
-    assert captured_payload["url"] == "https://api.test/prophet/v1/forecast"
+    assert captured_payload["url"] == f"{client.base_url}/prophet/v1/forecast"
     assert captured_payload["headers"] == client.headers
     assert captured_payload["json"] == {
         "series": [1.0, 2.0, 3.0],

{simulacrum_sdk-0.2.2 → simulacrum_sdk-0.2.3}/tests/test_errors.py

@@ -1,4 +1,9 @@
 import json
+import os
+import sys
+
+# Ensure package import works when running tests directly
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 from datetime import datetime, timedelta, timezone
 
 from simulacrum._errors import parse_error