moatlight 1.1.0__py3-none-any.whl

moatlight/__init__.py

@@ -0,0 +1,176 @@
+"""Moatlight API client. Standard library only.
+
+Writes carry an Idempotency-Key that stays the same across retries, and network errors, 429 and 5xx are
+retried (Retry-After honoured), so a retry can never start a second report.
+"""
+from __future__ import annotations
+
+import json
+import random
+import time
+import urllib.error
+import urllib.parse
+import urllib.request
+import uuid
+from typing import Any, Dict, Iterator, List, Optional
+
+__version__ = "1.1.0"
+DEFAULT_BASE_URL = "https://www.moatlight.com"
+__all__ = ["Moatlight", "MoatlightError", "DEFAULT_BASE_URL", "__version__"]
+
+
+class MoatlightError(Exception):
+    """An API error: HTTP status plus the code, message and hint from the JSON error body."""
+
+    def __init__(self, status: int, code: str, message: str, hint: Optional[str] = None,
+                 retry_after: Optional[int] = None, body: Any = None) -> None:
+        super().__init__(f"{code}: {message}")
+        self.status, self.code, self.message, self.hint = status, code, message, hint
+        self.retry_after, self.body = retry_after, body
+
+
+class Moatlight:
+    def __init__(self, token: Optional[str] = None, base_url: str = DEFAULT_BASE_URL,
+                 max_retries: int = 3, timeout: float = 60.0) -> None:
+        self.token = token
+        self.base_url = base_url.rstrip("/")
+        self.max_retries = max_retries
+        self.timeout = timeout
+        #: RateLimit headers of the last answer: {"limit", "remaining", "reset_seconds"}
+        self.last_rate_limit: Dict[str, Optional[int]] = {}
+
+    # ---- transport ----
+    def request(self, path: str, method: str = "GET", query: Optional[Dict[str, Any]] = None,
+                body: Any = None, idempotency_key: Optional[str] = None) -> Any:
+        url = self.base_url + path
+        params = {k: v for k, v in (query or {}).items() if v is not None}
+        if params:
+            url += "?" + urllib.parse.urlencode(params)
+        headers = {"Accept": "application/json", "User-Agent": f"moatlight-python/{__version__}"}
+        if self.token:
+            headers["Authorization"] = f"Bearer {self.token}"
+        data = None
+        if body is not None:
+            data = json.dumps(body).encode()
+            headers["Content-Type"] = "application/json"
+        if method == "POST":
+            headers["Idempotency-Key"] = idempotency_key or str(uuid.uuid4())
+        attempt = 0
+        while True:
+            req = urllib.request.Request(url, data=data, headers=headers, method=method)
+            try:
+                with urllib.request.urlopen(req, timeout=self.timeout) as res:
+                    self._rate(res.headers)
+                    text = res.read().decode()
+                    return json.loads(text) if text else None
+            except urllib.error.HTTPError as e:
+                self._rate(e.headers)
+                text = e.read().decode()
+                try:
+                    payload = json.loads(text)
+                except ValueError:
+                    payload = None
+                retry_after = int(e.headers.get("Retry-After") or 0) or None
+                if (e.code == 429 or e.code >= 500) and attempt < self.max_retries:
+                    time.sleep(min(retry_after, 60) if retry_after else _backoff(attempt))
+                    attempt += 1
+                    continue
+                err = (payload or {}).get("error", {}) if isinstance(payload, dict) else {}
+                raise MoatlightError(e.code, err.get("code", f"http_{e.code}"), err.get("message", e.reason),
+                                     err.get("hint"), retry_after, payload) from None
+            except (urllib.error.URLError, TimeoutError, ConnectionError):
+                if attempt >= self.max_retries:
+                    raise
+                time.sleep(_backoff(attempt))
+                attempt += 1
+
+    def _rate(self, h: Any) -> None:
+        def num(k: str) -> Optional[int]:
+            v = h.get(k)
+            return int(v) if v is not None and str(v).isdigit() else None
+        self.last_rate_limit = {"limit": num("RateLimit-Limit"), "remaining": num("RateLimit-Remaining"),
+                                "reset_seconds": num("RateLimit-Reset")}
+
+    # ---- public ----
+    def get_product(self, fields: Optional[str] = None) -> Dict[str, Any]:
+        return self.request("/api/v1/product", query={"fields": fields})
+
+    def get_pricing(self, fields: Optional[str] = None) -> Dict[str, Any]:
+        return self.request("/api/v1/pricing", query={"fields": fields})
+
+    def get_sample_report(self) -> Dict[str, Any]:
+        return self.request("/api/v1/sample-report")
+
+    def list_faq(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> Dict[str, Any]:
+        return self.request("/api/v1/faq", query={"limit": limit, "cursor": cursor})
+
+    # ---- account (OAuth token) ----
+    def get_account(self, fields: Optional[str] = None) -> Dict[str, Any]:
+        return self.request("/api/v1/me", query={"fields": fields})
+
+    def list_reports(self, limit: Optional[int] = None, cursor: Optional[str] = None) -> Dict[str, Any]:
+        return self.request("/api/v1/reports", query={"limit": limit, "cursor": cursor})
+
+    def all_reports(self, limit: int = 50) -> Iterator[Dict[str, Any]]:
+        """Every report, newest first, following next_cursor for you."""
+        cursor = None
+        while True:
+            page = self.list_reports(limit=limit, cursor=cursor)
+            yield from page["reports"]
+            cursor = page.get("next_cursor")
+            if not cursor:
+                return
+
+    def create_report(self, website: str, country: Optional[str] = None, language: Optional[str] = None,
+                      idempotency_key: Optional[str] = None) -> Dict[str, Any]:
+        body = {"website": website, **({"country": country} if country else {}), **({"language": language} if language else {})}
+        return self.request("/api/v1/reports", "POST", body=body, idempotency_key=idempotency_key)
+
+    def get_report(self, report_id: str, fields: Optional[str] = None) -> Dict[str, Any]:
+        return self.request(f"/api/v1/reports/{urllib.parse.quote(report_id, safe='')}", query={"fields": fields})
+
+    def batch_get_reports(self, report_ids: List[str]) -> Dict[str, Any]:
+        return self.request("/api/v1/reports/batch", "POST", body={"report_ids": report_ids})
+
+    def start_report(self, report_id: str, question_ids: Optional[List[str]] = None,
+                     idempotency_key: Optional[str] = None) -> Dict[str, Any]:
+        body = {"question_ids": question_ids} if question_ids else {}
+        return self.request(f"/api/v1/reports/{urllib.parse.quote(report_id, safe='')}/start", "POST", body=body,
+                            idempotency_key=idempotency_key)
+
+    def get_report_actions(self, report_id: str) -> Dict[str, Any]:
+        return self.request(f"/api/v1/reports/{urllib.parse.quote(report_id, safe='')}/actions")
+
+    def get_agent_readiness(self, report_id: str) -> Dict[str, Any]:
+        return self.request(f"/api/v1/reports/{urllib.parse.quote(report_id, safe='')}/agent-readiness")
+
+    def scan_agent_readiness(self, report_id: str, force: bool = False,
+                             idempotency_key: Optional[str] = None) -> Dict[str, Any]:
+        return self.request(f"/api/v1/reports/{urllib.parse.quote(report_id, safe='')}/agent-readiness/scan", "POST",
+                            body={"force": force}, idempotency_key=idempotency_key)
+
+    def wait_for_report(self, report_id: str, until: Optional[List[str]] = None, timeout: float = 300.0) -> Dict[str, Any]:
+        """Poll until the report reaches one of the stages in `until` (default: needs_confirmation, finished, failed)."""
+        until = until or ["needs_confirmation", "finished", "analysis_failed", "failed"]
+        deadline = time.time() + timeout
+        while True:
+            r = self.get_report(report_id)
+            if r.get("stage") in until:
+                return r
+            if time.time() > deadline:
+                raise TimeoutError(f"Timed out waiting for report {report_id} (stage {r.get('stage')}).")
+            time.sleep(r.get("poll_after_seconds") or 5)
+
+    # ---- sandbox: made-up data, no login ----
+    def sandbox_create_report(self, website: str) -> Dict[str, Any]:
+        return self.request("/api/v1/sandbox/reports", "POST", body={"website": website})
+
+    def sandbox_get_report(self, report_id: str = "sandbox-report") -> Dict[str, Any]:
+        return self.request(f"/api/v1/sandbox/reports/{urllib.parse.quote(report_id, safe='')}")
+
+    def sandbox_get_account(self) -> Dict[str, Any]:
+        return self.request("/api/v1/sandbox/me")
+
+
+def _backoff(attempt: int) -> float:
+    return min(8.0, 0.5 * 2 ** attempt) + random.random() * 0.25

moatlight-1.1.0.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: moatlight
+Version: 1.1.0
+Summary: Official Python client for the Moatlight API: measure whether ChatGPT and Google AI Overview name a business.
+Author-email: Moatlight <ceo@moatlight.com>
+License: MIT
+Project-URL: Homepage, https://www.moatlight.com
+Project-URL: Documentation, https://www.moatlight.com/docs
+Project-URL: Repository, https://github.com/Moatlight/moatlight-agent-kit
+Project-URL: OpenAPI, https://www.moatlight.com/openapi.json
+Keywords: moatlight,geo,aeo,ai-search,ai-visibility,mcp,sdk
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# moatlight (Python)
+
+Official Python client for the [Moatlight API](https://www.moatlight.com/docs): measure whether ChatGPT and Google AI Overview name a business. Standard library only; Python 3.9+.
+
+```bash
+pip install moatlight
+```
+
+```python
+from moatlight import Moatlight
+
+api = Moatlight()                              # no login: public endpoints and the sandbox
+print(api.sandbox_get_report()["stage"])       # "finished" (made-up data)
+
+api = Moatlight(token="...")                   # OAuth access token, see https://www.moatlight.com/auth.md
+report = api.create_report("yourcompany.com")  # 202 Accepted, safe to retry (Idempotency-Key)
+report = api.wait_for_report(report["id"])
+for r in api.all_reports():                    # follows next_cursor
+    print(r["id"], r["stage"])
+```
+
+Network errors, 429 and 5xx are retried (`Retry-After` honoured); errors raise `MoatlightError` with `status`, `code`, `message`, `hint`. Docs: https://www.moatlight.com/docs · Source: https://github.com/Moatlight/moatlight-agent-kit · MIT

moatlight-1.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+moatlight/__init__.py,sha256=e56bvOeb3PL3dIT-JPBY_zwRy08vxY8biUDPipPHKvY,8779
+moatlight/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+moatlight-1.1.0.dist-info/licenses/LICENSE,sha256=DLj9q3OR_rljO_XZ5748oUd45kdvQVF8MgOEyosPFFY,1066
+moatlight-1.1.0.dist-info/METADATA,sha256=KJwbkO4G_uaH6IV2TQiF8XoJCEKfuAlGjdOkLGuidlY,1808
+moatlight-1.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+moatlight-1.1.0.dist-info/top_level.txt,sha256=IGDhBdl-Kj2FlqFJjwkFEeC-OkDfSISNqNCODfwOTMg,10
+moatlight-1.1.0.dist-info/RECORD,,

moatlight-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

moatlight-1.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Moatlight
+
+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.

moatlight-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+moatlight