simudyne-pulse 0.7.0.dev5__tar.gz → 0.7.0.dev6__tar.gz

{simudyne_pulse-0.7.0.dev5/src/simudyne_pulse.egg-info → simudyne_pulse-0.7.0.dev6}/PKG-INFO

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

{simudyne_pulse-0.7.0.dev5 → simudyne_pulse-0.7.0.dev6}/pyproject.toml

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

simudyne_pulse-0.7.0.dev6/src/simudyne/resources/api_keys.py

@@ -0,0 +1,83 @@
+class ApiKeysResource:
+    def __init__(self, client):
+        self._client = client
+
+    def create(self, name: str):
+        """Mint a new API key.
+
+        The only call that ever returns the key material. It is shown once —
+        store it before the call returns, or mint another.
+
+        Parameters
+        ----------
+        name : str
+            A label for the key. Name it by purpose ("notebook",
+            "production", "CI pipeline") so you know which to revoke if one
+            is compromised.
+
+        Returns
+        -------
+        dict
+            api_key : str
+                The key material, shown exactly once.
+            api_key_id : str
+                The handle to pass to :meth:`revoke`.
+            warning : str
+                A reminder that the key will not be shown again.
+
+        Examples
+        --------
+        >>> new_key = client.api_keys.create(name="Training script")
+        >>> print(new_key["api_key"])  # save this, it won't be shown again
+        """
+        return self._client._request("POST", "/api-keys", json={"name": name})
+
+    def list(self):
+        """List your active API keys and their labels.
+
+        The full key is never returned after creation; only ``key_prefix``,
+        the first 12 characters, is stored. That is enough to tell keys apart
+        and not enough to reconstruct one.
+
+        Returns
+        -------
+        list of dict
+            One entry per key, each with:
+
+            - api_key_id (str): the handle to pass to :meth:`revoke`
+            - key_prefix (str): first 12 characters, e.g. "pk_live_ab12"
+            - name (str): the label you gave it
+            - is_active (bool): False once revoked
+            - created_at (str): when it was created
+            - last_used_at (str or None): None until the key is first used
+            - expires_at (str or None): None for keys that do not expire
+
+        Examples
+        --------
+        >>> for key in client.api_keys.list():
+        ...     print(key["name"], key["key_prefix"], key["created_at"])
+        """
+        return self._client._request("GET", "/api-keys")
+
+    def revoke(self, key_id: str):
+        """Invalidate a key immediately.
+
+        Any request still using the key returns HTTP 401 from this point on.
+
+        Parameters
+        ----------
+        key_id : str
+            The ``api_key_id`` from :meth:`list` or :meth:`create` — not the
+            key material itself.
+
+        Returns
+        -------
+        dict
+            The revocation result.
+
+        Examples
+        --------
+        >>> new_key = client.api_keys.create(name="Training script")
+        >>> client.api_keys.revoke(key_id=new_key["api_key_id"])
+        """
+        return self._client._request("DELETE", f"/api-keys/{key_id}")

simudyne_pulse-0.7.0.dev6/src/simudyne/resources/profile.py

@@ -0,0 +1,103 @@
+class ProfileResource:
+    def __init__(self, client):
+        self._client = client
+
+    def get(self):
+        """Return your account record.
+
+        The cheapest way to confirm a key works and to find out which tier it
+        is on — worth calling first when a 403 surprises you.
+
+        Returns
+        -------
+        dict
+            user_id : str
+                Your account id. Also your FIX CompID, where FIX is enabled.
+            email : str
+                The address the account was created with.
+            name : str
+                Display name.
+            organization : str
+                Organisation, empty string if never set.
+            is_admin : bool
+                Administrative flag governing user administration, not
+                simulator access. It is not a tier bypass: an admin flag on a
+                free-tier key still cannot run a simulation. When a call
+                returns 403, read ``tier``, not this.
+            tier : {"free", "pro", "demo"}
+                What gates every endpoint.
+            download_limit : int
+                New simulation groups per rolling 24 hours. Only enforced on
+                the free tier.
+
+        Examples
+        --------
+        >>> me = client.profile.get()
+        >>> print(f"{me['email']} — tier {me['tier']}")
+        """
+        return self._client._request("GET", "/profile")
+
+    def usage(self):
+        """Return your request count for the current calendar month.
+
+        Resets on the 1st, and counts *requests* rather than simulations —
+        one ``run()`` of 100 Monte Carlo runs is a single request here.
+
+        Returns
+        -------
+        dict
+            user_id : str
+                Your account id.
+            month : str
+                The calendar month being reported, "YYYY-MM".
+            total_requests : int
+                Requests so far this month.
+            by_endpoint : dict
+                Request count keyed by endpoint path. The keys are the
+                concrete paths that were called, so a job-scoped endpoint
+                appears once per job id rather than as a template — aggregate
+                by prefix if you want per-endpoint totals.
+
+        Examples
+        --------
+        >>> usage = client.profile.usage()
+        >>> print(f"{usage['month']}: {usage['total_requests']} requests")
+        """
+        return self._client._request("GET", "/profile/usage")
+
+    def downloads(self):
+        """Return the free-tier download allowance for the current window.
+
+        The unit is a simulation group — every Monte Carlo run of one
+        symbol/date/scenario — not a call, a run, or a file. Membership is
+        permanent: a group you have downloaded before is free to re-fetch
+        forever, in any run or file format.
+
+        Returns
+        -------
+        dict
+            limit : int or None
+                Groups per window. None on the pro and demo tiers, meaning
+                unlimited.
+            used : int
+                New groups added in the current window.
+            remaining : int or None
+                ``limit`` minus ``used``, floored at 0. None when unlimited.
+            window_hours : int
+                Length of the rolling window, 24.
+            downloaded_groups : list of str or None
+                Every group you have ever downloaded. None when unlimited.
+            downloaded_group_details : list of dict or None
+                The same groups, each with a ``downloaded_at`` timestamp.
+
+        Notes
+        -----
+        A request that would exceed the allowance returns HTTP 429 without
+        charging anything, so a partial download never silently eats quota.
+
+        Examples
+        --------
+        >>> quota = client.profile.downloads()
+        >>> print(f"{quota['used']}/{quota['limit']} used, {quota['remaining']} left")
+        """
+        return self._client._request("GET", "/profile/downloads")

{simudyne_pulse-0.7.0.dev5 → simudyne_pulse-0.7.0.dev6}/src/simudyne/resources/validation.py

@@ -232,6 +232,34 @@ class ValidationResource:
         exchange : str, optional
             Exchange protocol (e.g. "hkex_securities"). Defaults to
             the prefix parsed from sim_ids[0].
+        statistical : bool, optional
+            Area flag (pulse-check 1.10.0): run the statistical checks. Every
+            area flag left unset takes the server's default, so a job that
+            names none behaves exactly as it did before 1.10.0.
+        stylised_facts : bool, optional
+            Area flag: run the Cont stylised facts. Distinct from
+            ``run_stylised_facts``, which is the older tri-state pass toggle.
+        impact : bool, optional
+            Area flag: run the Bouchaud impact response. Distinct from
+            ``run_impact``, for the same reason.
+        volume_correlation : bool, optional
+            Area flag: run the volume-correlation checks.
+        fid : bool, optional
+            Area flag: compute the Frechet Inception Distance.
+        mind : bool, optional
+            Area flag: compute the Monge Inception Distance.
+        lob : bool, optional
+            Mark the supplied frames as L2 snapshots, which switches off
+            everything that needs the message stream.
+        sample_period : str, optional
+            The grid the book is resampled onto, e.g. "1s".
+        match_generated_sample : bool, optional
+            Resample the historical side onto the same grid as the generated
+            frames.
+        plots : bool or list of str, optional
+            False, True, or a list of plot ids to render.
+        historical_output : bool, optional
+            The demo-only gate that ``plot_data`` used to be.
 
         Returns
         -------
@@ -321,6 +349,52 @@ class ValidationResource:
         Notes
         -----
         The run flags mean exactly what they mean on :meth:`run`.
+        run_metrics : bool, optional
+            Compute L1/Wasserstein distributional distances. Tri-state: left
+            unset the API resolves it from your tier.
+        run_impact : bool, optional
+            Compute Bouchaud impact response curves. Tri-state.
+        run_inception_distances : bool, default True
+            Compute MIND and FID on DeepLOB embeddings. One flag gates both,
+            and unlike the others it defaults to on.
+        run_stylised_facts : bool, optional
+            Compute the eleven Cont stylised facts and their verdicts.
+            Tri-state.
+        plot_data : bool, optional
+            Store the raw data behind every plot. Demo tier only.
+        n_levels : int, default 10
+            L2 book levels to use. The inception distances need all 10.
+        l2_only : bool, default False
+            Restrict to metrics needing only bid/ask price and size. Disables
+            the impact pass.
+        statistical : bool, optional
+            Area flag (pulse-check 1.10.0): run the statistical checks. Every
+            area flag left unset takes the server's default, so a job that
+            names none behaves exactly as it did before 1.10.0.
+        stylised_facts : bool, optional
+            Area flag: run the Cont stylised facts. Distinct from
+            ``run_stylised_facts``, which is the older tri-state pass toggle.
+        impact : bool, optional
+            Area flag: run the Bouchaud impact response. Distinct from
+            ``run_impact``, for the same reason.
+        volume_correlation : bool, optional
+            Area flag: run the volume-correlation checks.
+        fid : bool, optional
+            Area flag: compute the Frechet Inception Distance.
+        mind : bool, optional
+            Area flag: compute the Monge Inception Distance.
+        lob : bool, optional
+            Mark the supplied frames as L2 snapshots, which switches off
+            everything that needs the message stream.
+        sample_period : str, optional
+            The grid the book is resampled onto, e.g. "1s".
+        match_generated_sample : bool, optional
+            Resample the historical side onto the same grid as the generated
+            frames.
+        plots : bool or list of str, optional
+            False, True, or a list of plot ids to render.
+        historical_output : bool, optional
+            The demo-only gate that ``plot_data`` used to be.
 
         Returns
         -------
@@ -496,6 +570,34 @@ class ValidationResource:
             Seconds between status checks (default 3)
         timeout : float, default 600.0
             Max seconds to wait (default 600)
+        statistical : bool, optional
+            Area flag (pulse-check 1.10.0): run the statistical checks. Every
+            area flag left unset takes the server's default, so a job that
+            names none behaves exactly as it did before 1.10.0.
+        stylised_facts : bool, optional
+            Area flag: run the Cont stylised facts. Distinct from
+            ``run_stylised_facts``, which is the older tri-state pass toggle.
+        impact : bool, optional
+            Area flag: run the Bouchaud impact response. Distinct from
+            ``run_impact``, for the same reason.
+        volume_correlation : bool, optional
+            Area flag: run the volume-correlation checks.
+        fid : bool, optional
+            Area flag: compute the Frechet Inception Distance.
+        mind : bool, optional
+            Area flag: compute the Monge Inception Distance.
+        lob : bool, optional
+            Mark the supplied frames as L2 snapshots, which switches off
+            everything that needs the message stream.
+        sample_period : str, optional
+            The grid the book is resampled onto, e.g. "1s".
+        match_generated_sample : bool, optional
+            Resample the historical side onto the same grid as the generated
+            frames.
+        plots : bool or list of str, optional
+            False, True, or a list of plot ids to render.
+        historical_output : bool, optional
+            The demo-only gate that ``plot_data`` used to be.
 
         Returns
         -------
@@ -657,18 +759,26 @@ class ValidationResource:
         }
 
     def display_plots(self, result: dict) -> "PlotDisplay":
-        """Return a PlotDisplay object for displaying validation plots.
-
-        Usage:
-            plots = client.validation.display_plots(result)
-            plots.distributions()    # show distribution histograms
-            plots.distances()        # show spider plots
-            plots.impact_response()  # show impact response plots
+        """Wrap a finished validation result in a plot renderer.
 
         Parameters
         ----------
         result : dict
-            The result dict from run_pipeline() or get_job()
+            The result dict from :meth:`run_pipeline` or :meth:`get_job`.
+
+        Returns
+        -------
+        PlotDisplay
+            Carries ``distributions()``, ``distances()``,
+            ``impact_response()`` and ``all()``, each of which renders in
+            place and returns None.
+
+        Examples
+        --------
+        >>> plots = client.validation.display_plots(result)
+        >>> plots.distributions()    # distribution histograms
+        >>> plots.distances()        # spider plots
+        >>> plots.impact_response()  # impact response curves
         """
         return PlotDisplay(result)
 

{simudyne_pulse-0.7.0.dev5 → simudyne_pulse-0.7.0.dev6/src/simudyne_pulse.egg-info}/PKG-INFO

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

simudyne_pulse-0.7.0.dev5/src/simudyne/resources/api_keys.py

@@ -1,12 +0,0 @@
-class ApiKeysResource:
-    def __init__(self, client):
-        self._client = client
-    
-    def create(self, name: str):
-        return self._client._request("POST", "/api-keys", json={"name": name})
-    
-    def list(self):
-        return self._client._request("GET", "/api-keys")
-    
-    def revoke(self, key_id: str):
-        return self._client._request("DELETE", f"/api-keys/{key_id}")

simudyne_pulse-0.7.0.dev5/src/simudyne/resources/profile.py

@@ -1,30 +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):
-        """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")