simudyne-pulse 0.8.0.dev1__tar.gz → 0.8.0.dev3__tar.gz

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.8.0.dev1
+Version: 0.8.0.dev3
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -19,7 +19,6 @@ License-File: LICENSE
 Requires-Dist: requests>=2.28.0
 Requires-Dist: polars>=0.20.0
 Requires-Dist: tqdm>=4.60.0
-Requires-Dist: websocket-client>=1.0.0
 Provides-Extra: test
 Requires-Dist: pytest>=8.0.0; extra == "test"
 Dynamic: license-file
@@ -231,7 +230,6 @@ the user guide is at https://pulse.simudyne.com/docs.
 | `client.validation` | `run`, `get_job_status`, `get_job`, `list_jobs` — results carry `errors` per failed area |
 | `client.fm` | `models`, `live`; admin: `registry`, `register`, `activate`, `deactivate` |
 | `client.fix` | FIX session usage |
-| `client.simulator_gym` | the interactive simulator websocket |
 
 Failures raise `PulseAPIError` with `status_code`, `detail` (exactly as the
 API sent it) and `errors`; `str(exc)` renders validation errors as

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/README.md

@@ -205,7 +205,6 @@ the user guide is at https://pulse.simudyne.com/docs.
 | `client.validation` | `run`, `get_job_status`, `get_job`, `list_jobs` — results carry `errors` per failed area |
 | `client.fm` | `models`, `live`; admin: `registry`, `register`, `activate`, `deactivate` |
 | `client.fix` | FIX session usage |
-| `client.simulator_gym` | the interactive simulator websocket |
 
 Failures raise `PulseAPIError` with `status_code`, `detail` (exactly as the
 API sent it) and `errors`; `str(exc)` renders validation errors as

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.8.0-dev.1"
+version = "0.8.0-dev.3"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"
@@ -24,7 +24,6 @@ dependencies = [
     "requests>=2.28.0",
     "polars>=0.20.0",
     "tqdm>=4.60.0",
-    "websocket-client>=1.0.0",
 ]
 
 [project.optional-dependencies]

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne/client.py

@@ -55,8 +55,6 @@ class PulseABM:
         Foundation-model generation and its job lifecycle.
     fix : FixResource
         FIX gateway usage.
-    simulator_gym : SimulatorGymResource
-        Gym-style reinforcement-learning environment over a WebSocket.
 
     Raises
     ------
@@ -109,7 +107,6 @@ class PulseABM:
         from simudyne.resources.fix import FixResource
         from simudyne.resources.fm import FmResource
         from simudyne.resources.simulation import SimulationResource
-        from simudyne.resources.simulator_gym import SimulatorGymResource
         from simudyne.resources.validation import ValidationResource
 
         self.profile = ProfileResource(self)
@@ -118,7 +115,6 @@ class PulseABM:
         self.fix = FixResource(self)
         self.fm = FmResource(self)
         self.simulation = SimulationResource(self)
-        self.simulator_gym = SimulatorGymResource(self)
         self.validation = ValidationResource(self)
 
     def _request_with_retries(self, method: str, url: str, **kwargs):

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne/resources/fm.py

@@ -118,8 +118,8 @@ class FmResource:
         -------
         dict
             ``{env, models}``: the environment, and the latest row per model
-            with the fields :meth:`models` returns plus ``image``, ``active``
-            and ``updated_by``.
+            with the fields :meth:`models` returns plus ``active`` and
+            ``updated_by``. The container image is not returned.
 
         Raises
         ------

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne/resources/simulation.py

@@ -211,8 +211,10 @@ class SimulationResource:
               ms, s, min, m or h, e.g. "500ms", "5s", "1min"
             - start_time (str): when to begin, "HH:MM" or "HH:MM:SS", e.g.
               "10:30:00"
-            - side (str or None): "buy" or "sell", overriding the scenario's
-              own direction
+
+            There is no side: each scenario sets its own direction
+            (flash_crash, gradual_selloff and trending_down sell; buy_panic
+            and trending_up buy).
         exec_algos : list of dict, optional
             Execution algorithms, same shape and meaning on both engines. Each
             entry needs "type":

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne_pulse.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.8.0.dev1
+Version: 0.8.0.dev3
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -19,7 +19,6 @@ License-File: LICENSE
 Requires-Dist: requests>=2.28.0
 Requires-Dist: polars>=0.20.0
 Requires-Dist: tqdm>=4.60.0
-Requires-Dist: websocket-client>=1.0.0
 Provides-Extra: test
 Requires-Dist: pytest>=8.0.0; extra == "test"
 Dynamic: license-file
@@ -231,7 +230,6 @@ the user guide is at https://pulse.simudyne.com/docs.
 | `client.validation` | `run`, `get_job_status`, `get_job`, `list_jobs` — results carry `errors` per failed area |
 | `client.fm` | `models`, `live`; admin: `registry`, `register`, `activate`, `deactivate` |
 | `client.fix` | FIX session usage |
-| `client.simulator_gym` | the interactive simulator websocket |
 
 Failures raise `PulseAPIError` with `status_code`, `detail` (exactly as the
 API sent it) and `errors`; `str(exc)` renders validation errors as

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne_pulse.egg-info/SOURCES.txt

@@ -11,7 +11,6 @@ src/simudyne/resources/fix.py
 src/simudyne/resources/fm.py
 src/simudyne/resources/profile.py
 src/simudyne/resources/simulation.py
-src/simudyne/resources/simulator_gym.py
 src/simudyne/resources/validation.py
 src/simudyne_pulse.egg-info/PKG-INFO
 src/simudyne_pulse.egg-info/SOURCES.txt
@@ -20,5 +19,4 @@ src/simudyne_pulse.egg-info/requires.txt
 src/simudyne_pulse.egg-info/top_level.txt
 tests/test_api_contract.py
 tests/test_new_resources.py
-tests/test_simulator_gym.py
 tests/test_validation.py

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/src/simudyne_pulse.egg-info/requires.txt

@@ -1,7 +1,6 @@
 requests>=2.28.0
 polars>=0.20.0
 tqdm>=4.60.0
-websocket-client>=1.0.0
 
 [test]
 pytest>=8.0.0

{simudyne_pulse-0.8.0.dev1 → simudyne_pulse-0.8.0.dev3}/tests/test_api_contract.py

@@ -61,11 +61,11 @@ class TestRunSendsWhatTheCallerSet:
     def test_scenario_on_fm_run_is_sent_for_the_api_to_reject(self):
         client = FakeClient()
         SimulationResource(client).run(
-            engine="fm", model_id="m", scenario="flash_crash", scenario_params={"side": "buy"}
+            engine="fm", model_id="m", scenario="flash_crash", scenario_params={"impact_multiplier": 2.0}
         )
         body = _sent(client)
         assert body["scenario"] == "flash_crash"
-        assert body["scenario_params"] == {"side": "buy"}
+        assert body["scenario_params"] == {"impact_multiplier": 2.0}
 
 
 class TestLrm:

simudyne_pulse-0.8.0.dev1/src/simudyne/resources/simulator_gym.py

@@ -1,304 +0,0 @@
-import json
-
-import websocket
-
-
-class GymSession:
-    """A live connection to a Pulse simulator-gym environment session.
-
-    Returned by
-    :meth:`SimulatorGymResource.connect` — not constructed directly. Unlike
-    every other object in this SDK the session is stateful and long-lived: it
-    holds a WebSocket open and is stepped, in the style of a Gymnasium
-    environment.
-
-    Use it as a context manager so the session is closed even if stepping
-    raises; otherwise call :meth:`close` yourself.
-
-    Parameters
-    ----------
-    ws : websocket.WebSocket
-        The open socket to the gym service.
-    session_id : str
-        Server-assigned id for this session.
-
-    Attributes
-    ----------
-    session_id : str
-        Server-assigned id for this session.
-
-    Examples
-    --------
-    >>> with client.simulator_gym.connect(
-    ...     symbol="700.HK", cal_date="2025-09-02", exchange="HKEX.Securities"
-    ... ) as env:
-    ...     obs = env.reset(seed=42)
-    ...     while True:
-    ...         result = env.step(0)
-    ...         if result["done"]:
-    ...             break
-    """
-
-    def __init__(self, ws: websocket.WebSocket, session_id: str):
-        self._ws = ws
-        self.session_id = session_id
-
-    def reset(self, seed: int = None) -> dict:
-        """Reset the environment and return the initial observation.
-
-        Parameters
-        ----------
-        seed : int, optional
-            Optional random seed for reproducibility.
-
-        Returns
-        -------
-        dict
-            Initial step result containing:
-
-            - type (str): the message type, "step"
-            - obs (list of float): the observation, 47 floats
-            - reward (float): always 0.0 for a reset
-            - done (bool): always False for a reset
-            - info (dict): per-step diagnostics from the simulator
-
-        Raises
-        ------
-        RuntimeError
-            If the simulator replies with an error. Note this resource raises
-            ``RuntimeError`` rather than ``PulseAPIError`` — it speaks
-            WebSocket, not HTTP.
-
-        See Also
-        --------
-        GymSession.step : Advance the episode.
-        GymSession.close : End the session.
-
-        Examples
-        --------
-        >>> obs = env.reset(seed=42)
-        >>> len(obs["obs"])
-        47
-
-        Reset without a seed for a fresh random episode:
-
-        >>> obs = env.reset()
-        """
-        self._ws.send(json.dumps({"type": "reset", "seed": seed}))
-        msg = json.loads(self._ws.recv())
-        if msg["type"] == "error":
-            raise RuntimeError(f"Simulator error: {msg['message']}")
-        return msg
-
-    def step(self, action: int) -> dict:
-        """Take one step in the environment.
-
-        Parameters
-        ----------
-        action : int
-            Integer action in range 0-13.
-
-        Returns
-        -------
-        dict
-            Step result containing:
-
-            - type (str): the message type, "step"
-            - obs (list of float): the observation, 47 floats
-            - reward (float): reward for this step
-            - done (bool): True once the episode has ended
-            - info (dict): per-step diagnostics from the simulator
-
-        Raises
-        ------
-        RuntimeError
-            If ``action`` is outside 0-13, or the simulator replies with an
-            error. Note this resource raises ``RuntimeError`` rather than
-            ``PulseAPIError`` — it speaks WebSocket, not HTTP.
-
-        See Also
-        --------
-        GymSession.reset : Start a new episode.
-        GymSession.close : End the session.
-
-        Examples
-        --------
-        >>> result = env.step(0)
-        >>> result["reward"], result["done"]
-        (0.0012, False)
-
-        Run an episode to completion, accumulating reward:
-
-        >>> total = 0.0
-        >>> obs = env.reset(seed=42)
-        >>> while not obs["done"]:
-        ...     obs = env.step(0)
-        ...     total += obs["reward"]
-        """
-        self._ws.send(json.dumps({"type": "step", "action": action}))
-        msg = json.loads(self._ws.recv())
-        if msg["type"] == "error":
-            raise RuntimeError(f"Simulator error: {msg['message']}")
-        return msg
-
-    def close(self):
-        """Close the session and the underlying WebSocket connection.
-
-        Sends a ``close`` message, waits for the acknowledgement, then shuts
-        the socket down. The socket is closed even if the acknowledgement never
-        arrives, so this is safe to call on a session that has already failed.
-        Calling it twice is harmless.
-
-        Called automatically when the session is used as a context manager.
-
-        See Also
-        --------
-        SimulatorGymResource.connect : Open a new session.
-
-        Examples
-        --------
-        >>> env = client.simulator_gym.connect(
-        ...     symbol="700.HK", cal_date="2025-09-02", exchange="HKEX.Securities"
-        ... )
-        >>> try:
-        ...     env.reset(seed=42)
-        ... finally:
-        ...     env.close()
-        """
-        try:
-            self._ws.send(json.dumps({"type": "close"}))
-            self._ws.recv()
-        finally:
-            self._ws.close()
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, *args):
-        self.close()
-
-
-class SimulatorGymResource:
-    """Open Gym-style reinforcement-learning environments over a WebSocket.
-
-    Reached as ``client.simulator_gym``. The API authenticates the socket with
-    your key and proxies it to the gym service, which drives the real engine.
-
-    This is the one resource that is stateful: :meth:`connect` returns a
-    :class:`GymSession` you hold open and step, rather than a dict.
-
-    Examples
-    --------
-    >>> with client.simulator_gym.connect(
-    ...     symbol="700.HK", cal_date="2025-09-02", exchange="HKEX.Securities"
-    ... ) as env:
-    ...     obs = env.reset(seed=42)
-    ...     result = env.step(0)
-    """
-
-    def __init__(self, client):
-        self._client = client
-
-    def _ws_base_url(self) -> str:
-        url = self._client.base_url
-        if url.startswith("https://"):
-            return "wss://" + url[len("https://"):]
-        if url.startswith("http://"):
-            return "ws://" + url[len("http://"):]
-        return url
-
-    def connect(self, symbol: str, cal_date: str, exchange: str) -> GymSession:
-        """Open a new simulator-gym session.
-
-        Parameters
-        ----------
-        symbol : str
-            Trading symbol, e.g. "700.HK"
-        cal_date : str
-            Calibration date, e.g. "2025-09-02"
-        exchange : str
-            Exchange identifier, e.g. "HKEX.Securities"
-
-        Returns
-        -------
-        GymSession
-            An open session, ready to :meth:`~GymSession.reset` and
-            :meth:`~GymSession.step`. Use it as a context manager so it is
-            closed on the way out.
-
-        Raises
-        ------
-        RuntimeError
-            If the key is rejected, the gym service cannot be reached, or the
-            service refuses the session — an unknown symbol or date, most
-            often. This resource raises ``RuntimeError`` rather than
-            ``PulseAPIError`` because it speaks WebSocket, not HTTP.
-
-        See Also
-        --------
-        GymSession.reset : Start an episode on the session.
-        GymSession.step : Advance it.
-        GymSession.close : End it.
-
-        Notes
-        -----
-        ``exchange`` takes its display form here — ``"HKEX.Securities"`` — not
-        the protocol slug ``"hkex_securities"`` used by
-        :meth:`~simudyne.resources.simulation.SimulationResource.run` and the
-        data catalog.
-
-        Examples
-        --------
-        >>> with client.simulator_gym.connect(
-        ...     symbol="700.HK",
-        ...     cal_date="2025-09-02",
-        ...     exchange="HKEX.Securities",
-        ... ) as env:
-        ...     obs = env.reset(seed=42)
-        ...     result = env.step(0)
-        ...     print(result["reward"], result["done"])
-
-        Without the context manager, close it yourself:
-
-        >>> env = client.simulator_gym.connect(
-        ...     symbol="700.HK", cal_date="2025-09-02", exchange="HKEX.Securities"
-        ... )
-        >>> try:
-        ...     env.reset(seed=42)
-        ... finally:
-        ...     env.close()
-        """
-        ws_url = f"{self._ws_base_url()}/ws/simulator-gym"
-        try:
-            ws = websocket.create_connection(
-                ws_url,
-                header={"X-API-Key": self._client.api_key},
-            )
-        except websocket.WebSocketBadStatusException as e:
-            if "403" in str(e):
-                raise RuntimeError(
-                    "Authentication failed: invalid or expired API key. "
-                    "Check your API key with client.api_keys.list()."
-                ) from e
-            raise RuntimeError(f"Failed to connect to simulator-gym: {e}") from e
-        except Exception as e:
-            raise RuntimeError(f"Failed to connect to simulator-gym: {e}") from e
-
-        ws.send(json.dumps({
-            "type": "create",
-            "config": {
-                "symbol": symbol,
-                "cal_date": cal_date,
-                "exchange": exchange,
-            }
-        }))
-
-        msg = json.loads(ws.recv())
-        if msg["type"] == "error":
-            ws.close()
-            raise RuntimeError(f"Failed to create session: {msg['message']}")
-        if msg["type"] != "created":
-            ws.close()
-            raise RuntimeError(f"Unexpected response type '{msg['type']}' during session creation")
-
-        return GymSession(ws, session_id=msg["session_id"])

simudyne_pulse-0.8.0.dev1/tests/test_simulator_gym.py

@@ -1,172 +0,0 @@
-import unittest
-from unittest.mock import MagicMock, patch, Mock
-import requests
-
-
-class TestSimulatorGymAuth(unittest.TestCase):
-    """Verify WebSocket authentication uses header instead of query param."""
-
-    @patch("simudyne.resources.simulator_gym.websocket.create_connection")
-    def test_connect_uses_header_auth(self, mock_create_connection):
-        mock_ws = MagicMock()
-        mock_ws.recv.return_value = '{"type": "created", "session_id": "test-123"}'
-        mock_create_connection.return_value = mock_ws
-
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_secret123")
-        client.simulator_gym.connect("700.HK", "2025-09-02", "HKEX.Securities")
-
-        mock_create_connection.assert_called_once()
-        call_args = mock_create_connection.call_args
-
-        url = call_args[0][0]
-        self.assertNotIn("api_key=", url, "API key should not be in URL query string")
-        self.assertNotIn("pk_test_secret123", url, "API key should not appear in URL")
-
-        header = call_args[1].get("header", {})
-        self.assertEqual(header.get("X-API-Key"), "pk_test_secret123", "API key should be in X-API-Key header")
-
-    @patch("simudyne.resources.simulator_gym.websocket.create_connection")
-    def test_connect_url_format(self, mock_create_connection):
-        mock_ws = MagicMock()
-        mock_ws.recv.return_value = '{"type": "created", "session_id": "test-123"}'
-        mock_create_connection.return_value = mock_ws
-
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_xyz", base_url="https://api.example.com")
-        client.simulator_gym.connect("700.HK", "2025-09-02", "HKEX.Securities")
-
-        url = mock_create_connection.call_args[0][0]
-        self.assertEqual(url, "wss://api.example.com/ws/simulator-gym")
-
-
-class TestClientTLSVerification(unittest.TestCase):
-    """Verify TLS verification is explicitly enabled."""
-
-    def test_session_verify_enabled(self):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123")
-        self.assertTrue(client.session.verify, "TLS verification should be explicitly True")
-
-
-class TestTimeoutAndRetry(unittest.TestCase):
-    """Verify timeout and exponential backoff behavior."""
-
-    def test_default_timeout(self):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123")
-        self.assertEqual(client.timeout, 30)
-
-    def test_custom_timeout(self):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123", timeout=60)
-        self.assertEqual(client.timeout, 60)
-
-    def test_custom_max_retries(self):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123", max_retries=5)
-        self.assertEqual(client.max_retries, 5)
-
-    @patch("simudyne.client.time.sleep")
-    def test_retries_on_503(self, mock_sleep):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123", max_retries=2)
-
-        mock_response_fail = Mock()
-        mock_response_fail.ok = False
-        mock_response_fail.status_code = 503
-
-        mock_response_ok = Mock()
-        mock_response_ok.ok = True
-        mock_response_ok.json.return_value = {"status": "ok"}
-
-        client.session.request = Mock(side_effect=[mock_response_fail, mock_response_ok])
-
-        result = client._request("GET", "/test")
-
-        self.assertEqual(result, {"status": "ok"})
-        self.assertEqual(client.session.request.call_count, 2)
-        mock_sleep.assert_called_once_with(1)
-
-    @patch("simudyne.client.time.sleep")
-    def test_raises_after_max_retries(self, mock_sleep):
-        from simudyne import PulseABM, PulseAPIError
-
-        client = PulseABM(api_key="pk_test_123", max_retries=2)
-
-        mock_response = Mock()
-        mock_response.ok = False
-        mock_response.status_code = 503
-        mock_response.text = "Service Unavailable"
-        mock_response.json.return_value = {"detail": "Service Unavailable"}
-
-        client.session.request = Mock(return_value=mock_response)
-
-        with self.assertRaises(PulseAPIError) as ctx:
-            client._request("GET", "/test")
-
-        self.assertEqual(ctx.exception.status_code, 503)
-        self.assertEqual(client.session.request.call_count, 3)
-
-    def test_no_retry_on_400(self):
-        from simudyne import PulseABM, PulseAPIError
-
-        client = PulseABM(api_key="pk_test_123", max_retries=3)
-
-        mock_response = Mock()
-        mock_response.ok = False
-        mock_response.status_code = 400
-        mock_response.text = "Bad Request"
-        mock_response.json.return_value = {"detail": "Bad Request"}
-
-        client.session.request = Mock(return_value=mock_response)
-
-        with self.assertRaises(PulseAPIError):
-            client._request("GET", "/test")
-
-        self.assertEqual(client.session.request.call_count, 1)
-
-    @patch("simudyne.client.time.sleep")
-    def test_retries_on_429_rate_limit(self, mock_sleep):
-        from simudyne import PulseABM
-
-        client = PulseABM(api_key="pk_test_123", max_retries=2)
-
-        mock_response_fail = Mock()
-        mock_response_fail.ok = False
-        mock_response_fail.status_code = 429
-
-        mock_response_ok = Mock()
-        mock_response_ok.ok = True
-        mock_response_ok.json.return_value = {"data": "success"}
-
-        client.session.request = Mock(side_effect=[mock_response_fail, mock_response_ok])
-
-        result = client._request("GET", "/test")
-
-        self.assertEqual(result, {"data": "success"})
-        self.assertEqual(client.session.request.call_count, 2)
-
-
-class TestPulseAPIError(unittest.TestCase):
-    """Verify custom exception behavior."""
-
-    def test_exception_attributes(self):
-        from simudyne import PulseAPIError
-
-        err = PulseAPIError(404, "Not Found")
-        self.assertEqual(err.status_code, 404)
-        self.assertEqual(err.detail, "Not Found")
-        self.assertIn("404", str(err))
-        self.assertIn("Not Found", str(err))
-
-
-if __name__ == "__main__":
-    unittest.main()