sentinelsup 0.2.1__tar.gz → 0.2.3__tar.gz

{sentinelsup-0.2.1 → sentinelsup-0.2.3}/.gitignore

@@ -1,7 +1,7 @@
-__pycache__/
-*.py[cod]
-*.egg-info/
-build/
-dist/
-.venv/
-.pytest_cache/
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.pytest_cache/

{sentinelsup-0.2.1 → sentinelsup-0.2.3}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Sentinel Edge Networks LTD
-
-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.
+MIT License
+
+Copyright (c) 2026 Sentinel Edge Networks LTD
+
+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.

{sentinelsup-0.2.1 → sentinelsup-0.2.3}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: sentinelsup
-Version: 0.2.1
-Summary: Sentinel — real-time fraud, VPN, proxy, and bot detection API. Free tier, sub-40ms response.
-Project-URL: Homepage, https://sntlhq.com
-Project-URL: Documentation, https://sntlhq.com/api
-Project-URL: Repository, https://github.com/sentinelsup/sentinel-python
-Project-URL: Issues, https://github.com/sentinelsup/sentinel-python/issues
-Author-email: Sentinel Edge Networks LTD <support@sntlhq.com>
+Version: 0.2.3
+Summary: Maskbreak — real-time fraud, VPN, proxy, and bot detection API. Free tier, sub-40ms response.
+Project-URL: Homepage, https://maskbreak.com
+Project-URL: Documentation, https://maskbreak.com/api
+Project-URL: Repository, https://github.com/sentinelsup/maskbreak-python
+Project-URL: Issues, https://github.com/sentinelsup/maskbreak-python/issues
+Author-email: Sentinel Edge Networks LTD <support@maskbreak.com>
 License: MIT
 License-File: LICENSE
 Keywords: antidetect-browser,api,bot-detection,device-fingerprinting,fraud-detection,proxy-detection,sentinel,vpn-detection
@@ -27,9 +27,9 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 
-# sentinelsup — Sentinel Python SDK
+# sentinelsup — Maskbreak Python SDK
 
-Official Python SDK for [Sentinel](https://sntlhq.com) — a real-time fraud detection API that flags VPNs, residential proxies, antidetect browsers (Kameleo, GoLogin, Multilogin), Tor exit nodes, and AI bots in under 40 ms.
+Official Python SDK for [Maskbreak](https://maskbreak.com) — a real-time fraud detection API that flags VPNs, residential proxies, antidetect browsers (Kameleo, GoLogin, Multilogin), Tor exit nodes, and AI bots in under 40 ms.
 
 [![PyPI](https://img.shields.io/pypi/v/sentinelsup.svg)](https://pypi.org/project/sentinelsup/)
 [![Python versions](https://img.shields.io/pypi/pyversions/sentinelsup.svg)](https://pypi.org/project/sentinelsup/)
@@ -43,12 +43,12 @@ Using Claude Code, Cursor, Copilot, or any AI coding assistant? Paste this one
 prompt and it wires the whole integration — frontend script, backend check,
 env var, and a test:
 
-> Fetch https://sntlhq.com/integrate.md and follow it to add Sentinel fraud
+> Fetch https://maskbreak.com/integrate.md and follow it to add Maskbreak fraud
 > protection to this app — protect signup, login, and checkout. My API key
 > is sk_live_YOUR_KEY; put it in a SENTINEL_KEY env var, never in
 > client-side code. Then show me how to test it.
 
-[`integrate.md`](https://sntlhq.com/integrate.md) is the canonical
+[`integrate.md`](https://maskbreak.com/integrate.md) is the canonical
 machine-readable integration guide, kept in sync with the live API.
 
 ## Install
@@ -57,7 +57,7 @@ machine-readable integration guide, kept in sync with the live API.
 pip install sentinelsup
 ```
 
-Python 3.8+. Get a free API key (no credit card) at [sntlhq.com/signup](https://sntlhq.com/signup).
+Python 3.8+. Get a free API key (no credit card) at [maskbreak.com/signup](https://maskbreak.com/signup).
 
 ## Quick start
 
@@ -92,10 +92,6 @@ print(info["verdict"])              # 'allow' | 'review' | 'block'
 print(info["signals"])              # {'vpn': ..., 'proxied': ..., 'tor': ..., 'dch': ..., 'anon': ...}
 ```
 
-> `email=` and `lookup()` ship in the **next PyPI release (0.2.1)** — on PyPI
-> today, use the raw HTTP endpoints documented at
-> [sntlhq.com/api](https://sntlhq.com/api) until it lands.
-
 ## What you get back
 
 `evaluate()` returns an `EvaluateResult` dataclass:
@@ -110,6 +106,10 @@ class EvaluateResult:
     network: dict               # {vpn, proxy, datacenter, anonymous, tor, residential, service}
     device: dict                # antidetect / automation / emulator signals
     reasons: list[str]          # machine-readable codes
+    email: dict | None          # {disposable: bool} — present when you passed email=
+    decision_source: str | None # 'rules' | 'exception' when your policy matched
+    engine_decision: str | None # engine's own verdict when policy changed the decision
+    test: bool                  # True for test-token / test-key calls
     raw: dict                   # full upstream response
 
     is_suspicious: bool         # True if decision != 'allow'
@@ -119,18 +119,18 @@ class EvaluateResult:
 Try the live sample (same shape, no key needed):
 
 ```bash
-curl "https://sntlhq.com/v1/evaluate/sample?scenario=vpn"
+curl "https://maskbreak.com/v1/evaluate/sample?scenario=vpn"
 ```
 
-Or use the [interactive playground](https://sntlhq.com/api#playground).
+Or use the [interactive playground](https://maskbreak.com/api#playground).
 
 ## Frontend setup
 
-Add the Sentinel SDK to your frontend. One script loads **both** layers —
+Add the Maskbreak SDK to your frontend. One script loads **both** layers —
 network (VPN/proxy/datacenter) and device (antidetect/bot/tampering):
 
 ```html
-<script async src="https://sntlhq.com/assets/sentinel.js"></script>
+<script async src="https://maskbreak.com/assets/sentinel.js"></script>
 
 <!-- Add class="monocle-enriched" to any form you want evaluated -->
 <form class="monocle-enriched" id="signup-form">
@@ -206,12 +206,12 @@ Runnable versions live in [`examples/`](./examples/).
 
 ## API
 
-### `Sentinel(api_key=None, endpoint="https://sntlhq.com", timeout=5.0)`
+### `Sentinel(api_key=None, endpoint="https://maskbreak.com", timeout=5.0)`
 
 | Option | Default | Description |
 |--------|---------|-------------|
 | `api_key` | `$SENTINEL_KEY` (falls back to `$SENTINEL_API_KEY`) | Your key starting with `sk_live_` |
-| `endpoint` | `https://sntlhq.com` | Override base URL (for testing) |
+| `endpoint` | `https://maskbreak.com` | Override base URL (for testing) |
 | `timeout` | `5.0` | Per-request timeout in seconds |
 
 ### `sentinel.evaluate(token, fingerprint_event_id=None, account_id=None, email=None)`
@@ -226,6 +226,24 @@ Returns `EvaluateResult`. Raises `SentinelError` on network/API failure.
 
 Returns the raw response dict for any public IPv4/IPv6 address (wraps `GET /v1/lookup/{ip}`): `verdict` (`allow`/`review`/`block`), `risk_score` (0–100), `known`, `signals` (`{vpn, proxied, tor, dch, anon}` or `None`), `network` (`{asn, org, country, city}`), `latency_ms`. Shares the per-key hourly quota with `evaluate()`. `known: False` means our feeds hold no data — it is **not** a clean guarantee.
 
+## Testing
+
+Deterministic test tokens exercise your allow / review / block handling end-to-end — no browser needed. Test calls are authenticated and rate-limited like real ones but never billed, stored, or webhooked, and the response carries `test=True`:
+
+```python
+result = s.evaluate(token="test_vpn")       # also: test_clean, test_proxy, test_datacenter, test_tor
+assert result.decision == "review"
+assert result.test
+```
+
+No account yet? The public sandbox key accepts the same test tokens:
+
+```python
+s = Sentinel(api_key="sk_test_sandbox")     # CI/staging — nothing billed, nothing stored
+```
+
+Every account also has a personal `sk_test_...` key (Settings → API Key) that runs the *complete* live pipeline — real tokens, your rules and exception pins included — while events stay flagged as test and never count toward usage or webhooks.
+
 ## Errors
 
 All failures raise `SentinelError`. The exception carries `.status` (HTTP code) and `.body` (parsed error body) when available.
@@ -247,9 +265,9 @@ except SentinelError as e:
 ## Rate limits
 
 Free tier: **1,000 requests/hour** per API key. No monthly cap, no credit
-card. Upgrade at [sntlhq.com](https://sntlhq.com) when you need more.
+card. Upgrade at [maskbreak.com](https://maskbreak.com) when you need more.
 
-## What Sentinel detects
+## What Maskbreak detects
 
 VPNs (commercial + self-hosted) · residential proxies (Bright Data, IPRoyal,
 and similar networks) · datacenter IPs · Tor exit nodes · antidetect browsers
@@ -259,10 +277,10 @@ virtual machines · browser tampering.
 
 ## Related
 
-- **Node.js SDK** — [`@sentinelsup/sdk`](https://github.com/sentinelsup/sentinel-node) on npm
-- **API docs** — [sntlhq.com/api](https://sntlhq.com/api)
-- **Free IP lookup tool** — [sntlhq.com/ip-lookup](https://sntlhq.com/ip-lookup)
+- **Node.js SDK** — [`@sentinelsup/sdk`](https://github.com/sentinelsup/maskbreak-node) on npm
+- **API docs** — [maskbreak.com/api](https://maskbreak.com/api)
+- **Free IP lookup tool** — [maskbreak.com/ip-lookup](https://maskbreak.com/ip-lookup)
 
 ## License
 
-MIT © [Sentinel Edge Networks LTD](https://sntlhq.com). See [LICENSE](LICENSE).
+MIT © [Sentinel Edge Networks LTD](https://maskbreak.com). See [LICENSE](LICENSE).