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

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev4
+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.dev4 → 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.4"
+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.dev4 → simudyne_pulse-0.7.0.dev6}/src/simudyne/resources/data.py

@@ -20,19 +20,28 @@ class DataResource:
         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.
-            q: Case-insensitive substring match over ticker and company name.
-            limit: Max instruments to return.
-            offset: Instruments to skip (for paging alongside limit).
+        Parameters
+        ----------
+        symbol : str, optional
+            Exact symbol, e.g. "700.HK".
+        exchange : str, optional
+            Exchange protocol, e.g. "hkex_securities".
+        provider : str, optional
+            Data provider, e.g. "omd" or "bmll".
+        date : str, optional
+            Calibration date "YYYY-MM-DD". Keeps only instruments
+            calibrated on that date, and narrows each instrument's
+            available_dates to it.
+        q : str, optional
+            Case-insensitive substring match over ticker and company name.
+        limit : int, optional
+            Max instruments to return.
+        offset : int, optional
+            Instruments to skip (for paging alongside limit).
 
-        Returns:
-            list of instrument dicts, each with available_dates.
+        Returns
+        -------
+        list of instrument dicts, each with available_dates.
         """
         params = {
             k: v for k, v in {

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev6}/src/simudyne/resources/fix.py

@@ -18,13 +18,15 @@ class FixResource:
     def usage(self) -> dict:
         """FIX simulation statistics: what was run over FIX, and how often.
 
-        Returns:
-            dict with ``total_runs``, ``simulated_seconds``, and ``runs`` — one
+        Returns
+        -------
+        dict with ``total_runs``, ``simulated_seconds``, and ``runs`` — one
             entry per distinct configuration, each with its ``symbol``,
             ``cal_date``, ``scenario`` and ``runs`` count.
 
-        Example:
-            >>> usage = client.fix.usage()
-            >>> print(f"{usage['total_runs']} FIX runs")
+        Examples
+        --------
+        >>> usage = client.fix.usage()
+        >>> print(f"{usage['total_runs']} FIX runs")
         """
         return self._client._request("GET", USAGE_PATH)

{simudyne_pulse-0.7.0.dev4 → simudyne_pulse-0.7.0.dev6}/src/simudyne/resources/fm.py

@@ -47,8 +47,9 @@ class FmResource:
         ``min_prompt_rows``, and the ``model_args`` descriptors for the knobs
         run() will accept. Pro tier.
 
-        Returns:
-            dict with a ``models`` list.
+        Returns
+        -------
+        dict with a ``models`` list.
         """
         return self._client._request("GET", MODELS_PATH)
 
@@ -71,19 +72,29 @@ class FmResource:
         restricts the result to the (provider, exchange) markets that model's
         ``supported_data`` declares — exactly what run() will accept.
 
-        Args:
-            model_id: Registered model (see models()). Unknown id -> 404.
-            symbol: Exact symbol, e.g. "TSCO" or "700".
-            q: Case-insensitive substring match over the symbol.
-            provider: Data provider, e.g. "bmll".
-            exchange: Protocol, e.g. "lse" or "hkex_securities".
-            date: Trading date YYYY-MM-DD; keeps only symbols with data on it,
-                and only that date.
-            limit: Max symbols to return (default 50, max 200).
-            offset: Symbols to skip, for paging.
-
-        Returns:
-            dict with ``symbols`` (each with its provider, exchange and dates)
+        Parameters
+        ----------
+        model_id : str, optional
+            Registered model (see models()). Unknown id -> 404.
+        symbol : str, optional
+            Exact symbol, e.g. "TSCO" or "700".
+        q : str, optional
+            Case-insensitive substring match over the symbol.
+        provider : str, optional
+            Data provider, e.g. "bmll".
+        exchange : str, optional
+            Protocol, e.g. "lse" or "hkex_securities".
+        date : str, optional
+            Trading date YYYY-MM-DD; keeps only symbols with data on it,
+            and only that date.
+        limit : int, default 50
+            Max symbols to return (default 50, max 200).
+        offset : int, default 0
+            Symbols to skip, for paging.
+
+        Returns
+        -------
+        dict with ``symbols`` (each with its provider, exchange and dates)
             and ``total``, paged by symbol identity.
         """
         params = {"limit": limit, "offset": offset}
@@ -112,28 +123,42 @@ class FmResource:
     ) -> dict:
         """Submit a foundation-model inference job. Pro tier.
 
-        Args:
-            model_id: A model from models().
-            symbol: Symbol whose real data becomes the prompt context.
-            cal_date: Trading date of the prompt, YYYY-MM-DD.
-            provider: Data provider, e.g. "bmll".
-            exchange: Exchange protocol, e.g. "hkex_securities".
-            duration_minutes: Sim horizon as wall-clock minutes measured from
-                the first row of the context. The resulting frame count is
-                reported in the run's output rather than requested up front.
-            horizon: Raw frame count — the older form; applies only when
-                duration_minutes is unset.
-            n_runs: Monte Carlo runs, 1-8 (per-run seeds derived from ``seed``
-                exactly as the ABM derives them).
-            seed: Random seed (default 42).
-            model_args: Overrides for the model's declared knobs (see
-                models()); unknown or out-of-range keys are rejected with 400.
-            device: "cpu" or "gpu"; None uses the model's default.
-            exec_algos: Execution algorithms, the ABM's config shape. At most
-                one per job; market runs only.
-
-        Returns:
-            dict with job_id, the model version, and the queued sim_ids.
+        Parameters
+        ----------
+        model_id : str
+            A model from models().
+        symbol : str
+            Symbol whose real data becomes the prompt context.
+        cal_date : str
+            Trading date of the prompt, YYYY-MM-DD.
+        provider : str
+            Data provider, e.g. "bmll".
+        exchange : str
+            Exchange protocol, e.g. "hkex_securities".
+        duration_minutes : float, optional
+            Sim horizon as wall-clock minutes measured from
+            the first row of the context. The resulting frame count is
+            reported in the run's output rather than requested up front.
+        horizon : int, optional
+            Raw frame count — the older form; applies only when
+            duration_minutes is unset.
+        n_runs : int, default 1
+            Monte Carlo runs, 1-8 (per-run seeds derived from ``seed``
+            exactly as the ABM derives them).
+        seed : int, default 42
+            Random seed (default 42).
+        model_args : dict, optional
+            Overrides for the model's declared knobs (see
+            models()); unknown or out-of-range keys are rejected with 400.
+        device : str, optional
+            "cpu" or "gpu"; None uses the model's default.
+        exec_algos : list, optional
+            Execution algorithms, the ABM's config shape. At most
+            one per job; market runs only.
+
+        Returns
+        -------
+        dict with job_id, the model version, and the queued sim_ids.
         """
         payload = {
             "model_id": model_id,
@@ -165,8 +190,9 @@ class FmResource:
     ) -> dict:
         """Start a live streaming session instead of a batch job. Pro tier.
 
-        Returns:
-            dict with ``token`` (used to connect to the live chart),
+        Returns
+        -------
+        dict with ``token`` (used to connect to the live chart),
             ``job_id`` and ``model_id``.
         """
         payload = {"model_id": model_id, "seed": seed}
@@ -179,8 +205,9 @@ class FmResource:
     def job_status(self, job_id: str) -> dict:
         """Foundation-model job status.
 
-        Returns:
-            dict with job_id, ``status``, ``message``, ``detail``,
+        Returns
+        -------
+        dict with job_id, ``status``, ``message``, ``detail``,
             ``started_at`` and ``completed_at``. ``status`` is one of queued,
             provisioning, starting, running, complete or failed — only the
             last two are terminal (see TERMINAL_STATUSES), so poll until one
@@ -193,7 +220,8 @@ class FmResource:
     def job_logs(self, job_id: str) -> dict:
         """Foundation-model job pod logs.
 
-        Returns:
-            dict with ``logs`` — the thing to read when a job failed.
+        Returns
+        -------
+        dict with ``logs`` — the thing to read when a job failed.
         """
         return self._client._request("GET", f"{JOBS_PATH}/{job_id}/logs")

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")