algoproven 0.1.0__tar.gz

algoproven-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AlgoProven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

algoproven-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: algoproven
+Version: 0.1.0
+Summary: The prop-firm rule runtime for futures bots — ask before every trade: can this break my prop account?
+Author: AlgoProven
+License: MIT
+Project-URL: Homepage, https://algoproven.com
+Project-URL: Documentation, https://app.algoproven.com/api/docs
+Keywords: prop-firm,futures,trading,risk,topstep,apex,rule-gate,drawdown
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# algoproven
+
+The prop-firm **rule runtime** for futures bots. Execution tools send trades — AlgoProven decides whether the next trade is **allowed under your exact prop-firm rules**. Ask before every order: *can this break my prop account?*
+
+Pure Python stdlib, no dependencies.
+
+## Install
+
+```bash
+pip install algoproven        # (publishing to PyPI soon)
+# from source: cd sdk && pip install -e .
+```
+
+## Use
+
+```python
+from algoproven import RuleGate
+
+gate = RuleGate()  # -> https://app.algoproven.com
+
+v = gate.check(firm="topstep_50k", symbol="ES", qty=2, stop_ticks=12, room=1000)
+print(v["decision"], "-", v["reason"])
+# ALLOW - Risk $300 is within $1,000 of room - $700 left after.
+
+# one-liner go/no-go inside your bot's order path:
+if not gate.allowed(firm="topstep_50k", symbol="ES", qty=5, stop_ticks=40, room=1000):
+    return  # REDUCE or BLOCK — skip the trade
+
+gate.firms()   # -> available presets
+```
+
+## Verdicts
+
+| decision | meaning |
+|---|---|
+| `ALLOW`  | risk fits the room — take it |
+| `REDUCE` | too big — `max_safe_qty` tells you the largest safe size |
+| `BLOCK`  | no safe size — tighten the stop or skip |
+
+Each verdict returns `{decision, reason, max_safe_qty, proposed_risk, room, distance_to_breach}`.
+
+## Inputs
+
+- `firm` — preset key (`topstep_50k`, `apex_50k`, `ffn_50k`; see `gate.firms()`)
+- `symbol` — `ES / MES / NQ / MNQ / MGC / MCL / M6E`
+- `qty`, `stop_ticks` — the proposed trade; OR pass `open_risk` (the $ you'd lose if stopped)
+- `room` — $ left before breach today (daily-loss room or live distance-to-breach). Defaults to the firm's binding line.
+
+## Notes
+
+v1 is **stateless** — it computes on the values you pass, holds no credentials, places no orders. Live account-state binding (real-time distance-to-breach, PayoutLock, multi-account) ships with the AlgoProven cockpit. Rules change weekly; confirm against your firm's official page.
+
+Not affiliated with any prop firm. Not financial advice.

algoproven-0.1.0/README.md

@@ -0,0 +1,53 @@
+# algoproven
+
+The prop-firm **rule runtime** for futures bots. Execution tools send trades — AlgoProven decides whether the next trade is **allowed under your exact prop-firm rules**. Ask before every order: *can this break my prop account?*
+
+Pure Python stdlib, no dependencies.
+
+## Install
+
+```bash
+pip install algoproven        # (publishing to PyPI soon)
+# from source: cd sdk && pip install -e .
+```
+
+## Use
+
+```python
+from algoproven import RuleGate
+
+gate = RuleGate()  # -> https://app.algoproven.com
+
+v = gate.check(firm="topstep_50k", symbol="ES", qty=2, stop_ticks=12, room=1000)
+print(v["decision"], "-", v["reason"])
+# ALLOW - Risk $300 is within $1,000 of room - $700 left after.
+
+# one-liner go/no-go inside your bot's order path:
+if not gate.allowed(firm="topstep_50k", symbol="ES", qty=5, stop_ticks=40, room=1000):
+    return  # REDUCE or BLOCK — skip the trade
+
+gate.firms()   # -> available presets
+```
+
+## Verdicts
+
+| decision | meaning |
+|---|---|
+| `ALLOW`  | risk fits the room — take it |
+| `REDUCE` | too big — `max_safe_qty` tells you the largest safe size |
+| `BLOCK`  | no safe size — tighten the stop or skip |
+
+Each verdict returns `{decision, reason, max_safe_qty, proposed_risk, room, distance_to_breach}`.
+
+## Inputs
+
+- `firm` — preset key (`topstep_50k`, `apex_50k`, `ffn_50k`; see `gate.firms()`)
+- `symbol` — `ES / MES / NQ / MNQ / MGC / MCL / M6E`
+- `qty`, `stop_ticks` — the proposed trade; OR pass `open_risk` (the $ you'd lose if stopped)
+- `room` — $ left before breach today (daily-loss room or live distance-to-breach). Defaults to the firm's binding line.
+
+## Notes
+
+v1 is **stateless** — it computes on the values you pass, holds no credentials, places no orders. Live account-state binding (real-time distance-to-breach, PayoutLock, multi-account) ships with the AlgoProven cockpit. Rules change weekly; confirm against your firm's official page.
+
+Not affiliated with any prop firm. Not financial advice.

algoproven-0.1.0/algoproven/__init__.py

@@ -0,0 +1,72 @@
+"""AlgoProven — the prop-firm rule runtime for futures bots.
+
+Ask before every trade: *can this break my prop account?*
+
+    from algoproven import RuleGate
+    gate = RuleGate()                       # -> https://app.algoproven.com
+    v = gate.check(firm="topstep_50k", symbol="ES", qty=2, stop_ticks=12, room=1000)
+    print(v["decision"], "-", v["reason"])  # ALLOW - Risk $300 is within $1,000 ...
+
+Stateless v1: you pass the firm preset + the proposed trade + your room-to-breach;
+the gate returns ALLOW / REDUCE / BLOCK with a reason, max safe size and distance.
+No broker credentials, no orders — it only *decides*. Pure stdlib (no dependencies).
+"""
+import json as _json
+import urllib.error
+import urllib.request
+from typing import Optional
+
+__version__ = "0.1.0"
+DEFAULT_BASE = "https://app.algoproven.com"
+
+
+class RuleGateError(RuntimeError):
+    pass
+
+
+class RuleGate:
+    """Pre-Trade Rule Gate client."""
+
+    def __init__(self, base_url: str = DEFAULT_BASE, api_key: Optional[str] = None, timeout: float = 10.0):
+        self.base = base_url.rstrip("/")
+        self.api_key = api_key
+        self.timeout = timeout
+
+    def check(self, firm: str = "topstep_50k", symbol: str = "ES", side: str = "BUY",
+              qty: int = 1, stop_ticks=None, open_risk=None, room=None) -> dict:
+        """Return the verdict dict: {decision, reason, max_safe_qty, proposed_risk,
+        room, distance_to_breach}. decision in {ALLOW, REDUCE, BLOCK}."""
+        payload = {"firm": firm, "symbol": symbol, "side": side, "qty": int(qty)}
+        if stop_ticks is not None:
+            payload["stop_ticks"] = stop_ticks
+        if open_risk is not None:
+            payload["open_risk"] = open_risk
+        if room is not None:
+            payload["room"] = room
+        return self._req("POST", "/api/v1/rulegate/check", payload)
+
+    def allowed(self, **kw) -> bool:
+        """True only if the verdict is ALLOW — the one-liner for a bot's go/no-go."""
+        return self.check(**kw).get("decision") == "ALLOW"
+
+    def firms(self) -> dict:
+        """List the available firm presets."""
+        return self._req("GET", "/api/v1/rulegate/firms")
+
+    # ---- transport (stdlib only) ----
+    def _req(self, method: str, path: str, payload: Optional[dict] = None) -> dict:
+        headers = {"Content-Type": "application/json", "User-Agent": f"algoproven-sdk/{__version__}"}
+        if self.api_key:
+            headers["X-API-Key"] = self.api_key
+        data = _json.dumps(payload).encode() if payload is not None else None
+        req = urllib.request.Request(self.base + path, data=data, headers=headers, method=method)
+        try:
+            with urllib.request.urlopen(req, timeout=self.timeout) as r:
+                return _json.loads(r.read().decode())
+        except urllib.error.HTTPError as e:
+            raise RuleGateError(f"RuleGate HTTP {e.code}: {e.read().decode()[:200]}") from None
+        except urllib.error.URLError as e:
+            raise RuleGateError(f"RuleGate unreachable: {e.reason}") from None
+
+
+__all__ = ["RuleGate", "RuleGateError", "__version__"]

algoproven-0.1.0/algoproven.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: algoproven
+Version: 0.1.0
+Summary: The prop-firm rule runtime for futures bots — ask before every trade: can this break my prop account?
+Author: AlgoProven
+License: MIT
+Project-URL: Homepage, https://algoproven.com
+Project-URL: Documentation, https://app.algoproven.com/api/docs
+Keywords: prop-firm,futures,trading,risk,topstep,apex,rule-gate,drawdown
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# algoproven
+
+The prop-firm **rule runtime** for futures bots. Execution tools send trades — AlgoProven decides whether the next trade is **allowed under your exact prop-firm rules**. Ask before every order: *can this break my prop account?*
+
+Pure Python stdlib, no dependencies.
+
+## Install
+
+```bash
+pip install algoproven        # (publishing to PyPI soon)
+# from source: cd sdk && pip install -e .
+```
+
+## Use
+
+```python
+from algoproven import RuleGate
+
+gate = RuleGate()  # -> https://app.algoproven.com
+
+v = gate.check(firm="topstep_50k", symbol="ES", qty=2, stop_ticks=12, room=1000)
+print(v["decision"], "-", v["reason"])
+# ALLOW - Risk $300 is within $1,000 of room - $700 left after.
+
+# one-liner go/no-go inside your bot's order path:
+if not gate.allowed(firm="topstep_50k", symbol="ES", qty=5, stop_ticks=40, room=1000):
+    return  # REDUCE or BLOCK — skip the trade
+
+gate.firms()   # -> available presets
+```
+
+## Verdicts
+
+| decision | meaning |
+|---|---|
+| `ALLOW`  | risk fits the room — take it |
+| `REDUCE` | too big — `max_safe_qty` tells you the largest safe size |
+| `BLOCK`  | no safe size — tighten the stop or skip |
+
+Each verdict returns `{decision, reason, max_safe_qty, proposed_risk, room, distance_to_breach}`.
+
+## Inputs
+
+- `firm` — preset key (`topstep_50k`, `apex_50k`, `ffn_50k`; see `gate.firms()`)
+- `symbol` — `ES / MES / NQ / MNQ / MGC / MCL / M6E`
+- `qty`, `stop_ticks` — the proposed trade; OR pass `open_risk` (the $ you'd lose if stopped)
+- `room` — $ left before breach today (daily-loss room or live distance-to-breach). Defaults to the firm's binding line.
+
+## Notes
+
+v1 is **stateless** — it computes on the values you pass, holds no credentials, places no orders. Live account-state binding (real-time distance-to-breach, PayoutLock, multi-account) ships with the AlgoProven cockpit. Rules change weekly; confirm against your firm's official page.
+
+Not affiliated with any prop firm. Not financial advice.

algoproven-0.1.0/algoproven.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+LICENSE
+README.md
+pyproject.toml
+algoproven/__init__.py
+algoproven.egg-info/PKG-INFO
+algoproven.egg-info/SOURCES.txt
+algoproven.egg-info/dependency_links.txt
+algoproven.egg-info/top_level.txt

algoproven-0.1.0/algoproven.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

algoproven-0.1.0/algoproven.egg-info/top_level.txt

@@ -0,0 +1 @@
+algoproven

algoproven-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "algoproven"
+version = "0.1.0"
+description = "The prop-firm rule runtime for futures bots — ask before every trade: can this break my prop account?"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{ name = "AlgoProven" }]
+keywords = ["prop-firm", "futures", "trading", "risk", "topstep", "apex", "rule-gate", "drawdown"]
+
+[project.urls]
+Homepage = "https://algoproven.com"
+Documentation = "https://app.algoproven.com/api/docs"
+
+[tool.setuptools]
+packages = ["algoproven"]

algoproven-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+