simudyne-pulse 0.6.0.dev1__tar.gz → 0.6.0.dev2__tar.gz

{simudyne_pulse-0.6.0.dev1/src/simudyne_pulse.egg-info → simudyne_pulse-0.6.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.6.0.dev1
+Version: 0.6.0.dev2
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

{simudyne_pulse-0.6.0.dev1 → simudyne_pulse-0.6.0.dev2}/pyproject.toml

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

simudyne_pulse-0.6.0.dev2/src/simudyne/resources/data.py

@@ -0,0 +1,45 @@
+AVAILABLE_SYMBOLS_PATH = "/data/available-symbols"
+
+
+class DataResource:
+    def __init__(self, client):
+        self._client = client
+
+    def get_available_symbols(
+        self,
+        symbol: str | None = None,
+        exchange: str | None = None,
+        provider: str | None = None,
+        date: str | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
+    ):
+        """List calibrated instruments and the dates available for each.
+
+        All arguments are optional filters; with none passed the whole catalog
+        comes back, as before.
+
+        Args:
+            symbol: Exact symbol, e.g. "700.HK".
+            exchange: Exchange protocol, e.g. "hkex_securities".
+            provider: Data provider, e.g. "omd" or "bmll".
+            date: Calibration date "YYYY-MM-DD". Keeps only instruments
+                  calibrated on that date, and narrows each instrument's
+                  available_dates to it.
+            limit: Max instruments to return.
+            offset: Instruments to skip (for paging alongside limit).
+
+        Returns:
+            list of instrument dicts, each with available_dates.
+        """
+        params = {
+            k: v for k, v in {
+                "symbol": symbol,
+                "exchange": exchange,
+                "provider": provider,
+                "date": date,
+                "limit": limit,
+                "offset": offset,
+            }.items() if v is not None
+        }
+        return self._client._request("GET", AVAILABLE_SYMBOLS_PATH, params=params or None)

simudyne_pulse-0.6.0.dev2/src/simudyne/resources/profile.py

@@ -0,0 +1,30 @@
+class ProfileResource:
+    def __init__(self, client):
+        self._client = client
+
+    def get(self):
+        return self._client._request("GET", "/profile")
+    
+    def usage(self):
+        return self._client._request("GET", "/profile/usage")
+
+    def downloads(self):
+        """Download quota usage for the current rolling 24-hour window.
+
+        Returns a dict with ``limit``, ``used``, ``remaining``,
+        ``window_hours`` and ``downloaded_groups``. ``limit`` and
+        ``remaining`` are ``None`` on the pro and demo tiers (unlimited); on
+        the free tier they reflect the account's daily download allowance.
+
+        A "download" is one simulation group (all Monte Carlo runs of one
+        scenario). ``used`` counts NEW groups added in the window;
+        ``downloaded_groups`` lists every group you have ever downloaded —
+        membership is permanent, so those are free to re-fetch forever in any
+        run or file format.
+
+        Example:
+            >>> quota = client.profile.downloads()
+            >>> print(f"{quota['used']}/{quota['limit']} used, {quota['remaining']} left")
+            >>> print(f"{len(quota['downloaded_groups'])} groups owned")
+        """
+        return self._client._request("GET", "/profile/downloads")

{simudyne_pulse-0.6.0.dev1 → simudyne_pulse-0.6.0.dev2}/src/simudyne/resources/simulation.py

@@ -496,6 +496,13 @@ class SimulationResource:
         """
         Download simulation data as a Polars DataFrame.
 
+        Free-tier quota: downloading from a cached simulation group you haven't
+        downloaded before consumes one unit of the daily allowance (HTTP 429
+        once exhausted). Groups you've already downloaded — via this method,
+        the bulk ZIP, or the web explorer — stay free forever, any run or file
+        format. Your own job runs are never charged. See
+        ``client.profile.downloads()``.
+
         Args:
             sim_id: The simulation ID
             filename: File to download. Options:
@@ -656,13 +663,13 @@ class SimulationResource:
         Returns:
             bytes: ZIP file content containing requested parquet files
 
-        Free-tier quota: bulk downloads are capped per rolling 24-hour window
-        (default 3). One unit is consumed per distinct simulation group (all
-        Monte Carlo runs of one scenario) — not per call, run, or file format,
-        and re-fetching a group already counted in the window is free. The API
-        returns HTTP 429 when a request would exceed the allowance. Check your
-        remaining quota with ``client.profile.downloads()``. Pro and demo
-        tiers are unlimited.
+        Free-tier quota: at most N NEW simulation groups per rolling 24-hour
+        window (default 3). One unit is consumed per distinct group (all Monte
+        Carlo runs of one scenario) — not per call, run, or file format — and
+        membership is permanent: a group you've downloaded before is free to
+        re-fetch forever. The API returns HTTP 429 (charging nothing) when a
+        request would exceed the allowance. Check your quota and owned groups
+        with ``client.profile.downloads()``. Pro and demo tiers are unlimited.
 
         Example - Download sim_data for multiple sims:
             >>> cached = client.simulation.list_cached(symbol="700.HK")

{simudyne_pulse-0.6.0.dev1 → simudyne_pulse-0.6.0.dev2/src/simudyne_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.6.0.dev1
+Version: 0.6.0.dev2
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

simudyne_pulse-0.6.0.dev1/src/simudyne/resources/data.py

@@ -1,9 +0,0 @@
-AVAILABLE_SYMBOLS_PATH = "/data/available-symbols"
-
-
-class DataResource:
-    def __init__(self, client):
-        self._client = client
-
-    def get_available_symbols(self):
-        return self._client._request("GET", AVAILABLE_SYMBOLS_PATH)

simudyne_pulse-0.6.0.dev1/src/simudyne/resources/profile.py

@@ -1,25 +0,0 @@
-class ProfileResource:
-    def __init__(self, client):
-        self._client = client
-
-    def get(self):
-        return self._client._request("GET", "/profile")
-    
-    def usage(self):
-        return self._client._request("GET", "/profile/usage")
-
-    def downloads(self):
-        """Bulk-download quota usage for the current rolling 24-hour window.
-
-        Returns a dict with ``limit``, ``used``, ``remaining`` and
-        ``window_hours``. ``limit`` and ``remaining`` are ``None`` on the
-        pro and demo tiers (unlimited); on the free tier they reflect the
-        account's daily download allowance. A "download" is one simulation
-        group (all Monte Carlo runs of one scenario) — re-fetching a group
-        already downloaded in the window, in any file format, is free.
-
-        Example:
-            >>> quota = client.profile.downloads()
-            >>> print(f"{quota['used']}/{quota['limit']} used, {quota['remaining']} left")
-        """
-        return self._client._request("GET", "/profile/downloads")