simudyne-pulse 0.7.0.dev7__tar.gz → 0.7.0.dev8__tar.gz

{simudyne_pulse-0.7.0.dev7/src/simudyne_pulse.egg-info → simudyne_pulse-0.7.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev7
+Version: 0.7.0.dev8
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -59,6 +59,55 @@ pip install --pre simudyne-pulse
 Only use dev builds for testing unreleased changes; they are not guaranteed
 stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
+### Working from a checkout
+
+To run the SDK from source — editing it, or using unreleased changes — install
+it editable **into the interpreter you will actually import from**. A notebook
+kernel is frequently not the python on your `$PATH`:
+
+```bash
+# in a notebook, find the right interpreter first
+import sys; print(sys.executable)
+
+# then, with that path
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+Check which copy you loaded — this is worth doing whenever an attribute seems
+to be missing:
+
+```python
+import simudyne
+from importlib.metadata import version
+
+print(simudyne.__file__)          # should be .../pulse-sdk/src/simudyne/...
+print(version("simudyne-pulse"))
+```
+
+#### If an older install shadows it
+
+The SDK was once published under the distribution name **`simudyne`**; it is
+now **`simudyne-pulse`**. Both ship a module called `simudyne`, and the older
+one installs a real directory while the editable install only adds a path
+entry — so the old copy wins and you get errors like
+`'PulseABM' object has no attribute 'validation'` from a version that predates
+the feature. `pip list` shows both. Remove the obsolete one:
+
+```bash
+<that python> -m pip uninstall simudyne      # the old distribution
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+### Running the tests
+
+```bash
+uv run --with pytest --with requests --with pandas --with pyarrow \
+    python -m pytest tests/ -q
+```
+
+No network: the client's `_request` is replaced with a recorder, so the tests
+assert the exact payload the API would receive.
+
 ## Quick start
 
 ```python

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8}/README.md

@@ -33,6 +33,55 @@ pip install --pre simudyne-pulse
 Only use dev builds for testing unreleased changes; they are not guaranteed
 stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
+### Working from a checkout
+
+To run the SDK from source — editing it, or using unreleased changes — install
+it editable **into the interpreter you will actually import from**. A notebook
+kernel is frequently not the python on your `$PATH`:
+
+```bash
+# in a notebook, find the right interpreter first
+import sys; print(sys.executable)
+
+# then, with that path
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+Check which copy you loaded — this is worth doing whenever an attribute seems
+to be missing:
+
+```python
+import simudyne
+from importlib.metadata import version
+
+print(simudyne.__file__)          # should be .../pulse-sdk/src/simudyne/...
+print(version("simudyne-pulse"))
+```
+
+#### If an older install shadows it
+
+The SDK was once published under the distribution name **`simudyne`**; it is
+now **`simudyne-pulse`**. Both ship a module called `simudyne`, and the older
+one installs a real directory while the editable install only adds a path
+entry — so the old copy wins and you get errors like
+`'PulseABM' object has no attribute 'validation'` from a version that predates
+the feature. `pip list` shows both. Remove the obsolete one:
+
+```bash
+<that python> -m pip uninstall simudyne      # the old distribution
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+### Running the tests
+
+```bash
+uv run --with pytest --with requests --with pandas --with pyarrow \
+    python -m pytest tests/ -q
+```
+
+No network: the client's `_request` is replaced with a recorder, so the tests
+assert the exact payload the API would receive.
+
 ## Quick start
 
 ```python

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.7.0-dev.7"
+version = "0.7.0-dev.8"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8}/src/simudyne/resources/validation.py

@@ -276,8 +276,10 @@ class ValidationResource:
                 },
             )
         else:
+            # Three-tuple parts: the content type matters to the server's
+            # multipart parser, so it is sent explicitly.
             files = [
-                ("sim_files", _frame_to_parquet(entry, i))
+                ("sim_files", (*_frame_to_parquet(entry, i), "application/octet-stream"))
                 for i, entry in enumerate(sim_files)
             ]
             submitted = self._client._request(

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8/src/simudyne_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev7
+Version: 0.7.0.dev8
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -59,6 +59,55 @@ pip install --pre simudyne-pulse
 Only use dev builds for testing unreleased changes; they are not guaranteed
 stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
+### Working from a checkout
+
+To run the SDK from source — editing it, or using unreleased changes — install
+it editable **into the interpreter you will actually import from**. A notebook
+kernel is frequently not the python on your `$PATH`:
+
+```bash
+# in a notebook, find the right interpreter first
+import sys; print(sys.executable)
+
+# then, with that path
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+Check which copy you loaded — this is worth doing whenever an attribute seems
+to be missing:
+
+```python
+import simudyne
+from importlib.metadata import version
+
+print(simudyne.__file__)          # should be .../pulse-sdk/src/simudyne/...
+print(version("simudyne-pulse"))
+```
+
+#### If an older install shadows it
+
+The SDK was once published under the distribution name **`simudyne`**; it is
+now **`simudyne-pulse`**. Both ship a module called `simudyne`, and the older
+one installs a real directory while the editable install only adds a path
+entry — so the old copy wins and you get errors like
+`'PulseABM' object has no attribute 'validation'` from a version that predates
+the feature. `pip list` shows both. Remove the obsolete one:
+
+```bash
+<that python> -m pip uninstall simudyne      # the old distribution
+<that python> -m pip install -e /path/to/pulse-sdk
+```
+
+### Running the tests
+
+```bash
+uv run --with pytest --with requests --with pandas --with pyarrow \
+    python -m pytest tests/ -q
+```
+
+No network: the client's `_request` is replaced with a recorder, so the tests
+assert the exact payload the API would receive.
+
 ## Quick start
 
 ```python

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8}/tests/test_new_resources.py

@@ -1,4 +1,4 @@
-"""Payload tests for the 0.8.0 surface: validation.run_upload, the fm and fix
+"""Payload tests for the 0.8.0 surface: validation.run, the fm and fix
 resources, and simulation.get_job_logs / run_lrm.
 
 No network — same recorder pattern as test_validation.py. These pin the wire
@@ -30,7 +30,7 @@ class TestRunUpload:
     def test_rejects_empty_before_any_request(self):
         client = FakeClient()
         with pytest.raises(ValueError, match="empty"):
-            ValidationResource(client).run_upload(
+            ValidationResource(client).run(
                 "700.HK", "2025-09-01", "omd", "hkex_securities", sim_files=[]
             )
         assert client.calls == []
@@ -39,18 +39,18 @@ class TestRunUpload:
         client = FakeClient()
         files = [(f"sim_{i}.parquet", b"x") for i in range(26)]
         with pytest.raises(ValueError, match="25"):
-            ValidationResource(client).run_upload(
+            ValidationResource(client).run(
                 "700.HK", "2025-09-01", "omd", "hkex_securities", sim_files=files
             )
         assert client.calls == []
 
     def test_multipart_payload_shape(self):
         client = FakeClient([{"job_id": "v1", "status": "pending"}])
-        ValidationResource(client).run_upload(
+        ValidationResource(client).run(
             "700.HK", "2025-09-01", "omd", "hkex_securities",
             sim_files=[("sim_0000.parquet", b"PARQ")],
             ticksize=0.5,
-            run_metrics=False,
+            statistical=False,
         )
         method, path, kwargs = client.calls[0]
         assert (method, path) == ("POST", "/validation/run/upload")
@@ -58,11 +58,11 @@ class TestRunUpload:
         assert data["provider"] == "omd" and data["exchange"] == "hkex_securities"
         assert data["ticksize"] == "0.5"
         config = json.loads(data["config"])
-        # explicit False sent; unset tri-state flags omitted (tier default)
-        assert config["run_metrics"] is False
-        for flag in ("run_impact", "run_stylised_facts", "plot_data"):
+        # explicit False sent; unset area flags omitted (tier default)
+        assert config["statistical"] is False
+        for flag in ("impact", "stylised_facts", "fid", "mind",
+                     "run_metrics", "plot_data"):
             assert flag not in config
-        assert config["run_fid"] is True
         [(field, (filename, content, mime))] = kwargs["files"]
         assert field == "sim_files" and filename == "sim_0000.parquet"
         assert content == b"PARQ" and mime == "application/octet-stream"
@@ -70,8 +70,8 @@ class TestRunUpload:
     def test_reads_paths_from_disk(self, tmp_path):
         p = tmp_path / "sim_0001.parquet"
         p.write_bytes(b"BYTES")
-        client = FakeClient([{}])
-        ValidationResource(client).run_upload(
+        client = FakeClient([{"job_id": "v1"}])
+        ValidationResource(client).run(
             "700.HK", "2025-09-01", "omd", "hkex_securities", sim_files=[p]
         )
         [(_, (filename, content, _))] = client.calls[0][2]["files"]

{simudyne_pulse-0.7.0.dev7 → simudyne_pulse-0.7.0.dev8}/tests/test_validation.py

@@ -216,12 +216,14 @@ class TestSimulatedFrameShapes:
         return client.calls[0][2]["files"]
 
     def test_pair(self):
-        assert self._files_sent([("a.parquet", b"x")])[0][1] == ("a.parquet", b"x")
+        part = self._files_sent([("a.parquet", b"x")])[0][1]
+        assert part == ("a.parquet", b"x", "application/octet-stream")
 
     def test_path(self, tmp_path):
         p = tmp_path / "sim.parquet"
         p.write_bytes(b"data")
-        assert self._files_sent([str(p)])[0][1] == ("sim.parquet", b"data")
+        part = self._files_sent([str(p)])[0][1]
+        assert part == ("sim.parquet", b"data", "application/octet-stream")
 
     def test_each_frame_gets_its_own_name(self):
         pd = pytest.importorskip("pandas")