pushary 1.1.0__py3-none-any.whl

pushary/__init__.py

@@ -0,0 +1,38 @@
+"""Pushary Python SDK.
+
+Human-in-the-loop decisions for AI products: create a decision, ask a specific
+end-user to approve it, and resume on their answer via webhook or poll. Zero
+runtime dependencies, stdlib only.
+"""
+
+from __future__ import annotations
+
+from ._types import (
+    CancelDecisionResponse,
+    CreateDecisionResponse,
+    Decision,
+    DecisionStatus,
+    DecisionType,
+    WebhookSecretResponse,
+)
+from .client import PusharyServer
+from .decisions import DecisionsResource
+from .errors import PusharyError
+from .webhook import SIGNATURE_HEADER, verify_webhook_signature
+
+__version__ = "1.1.0"
+
+__all__ = [
+    "PusharyServer",
+    "DecisionsResource",
+    "PusharyError",
+    "verify_webhook_signature",
+    "SIGNATURE_HEADER",
+    "Decision",
+    "DecisionType",
+    "DecisionStatus",
+    "CreateDecisionResponse",
+    "CancelDecisionResponse",
+    "WebhookSecretResponse",
+    "__version__",
+]

pushary/_types.py

@@ -0,0 +1,75 @@
+"""Typed shapes for the decision payloads.
+
+The client methods return plain ``dict`` objects parsed straight from the API
+response. These ``TypedDict`` definitions describe the keys those dicts carry so
+editors and type checkers can help, without forcing any runtime conversion.
+"""
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+try:  # TypedDict and Literal live in typing on Python 3.9+
+    from typing import Literal, TypedDict
+except ImportError:  # pragma: no cover - defensive for very old runtimes
+    from typing_extensions import Literal, TypedDict  # type: ignore
+
+
+DecisionType = Literal["confirm", "select", "input"]
+"""How the human answers: a yes/no confirm, a fixed set of options, or free text."""
+
+DecisionStatus = Literal["pending", "answered", "expired", "cancelled"]
+"""Lifecycle state of a decision."""
+
+
+class CreateDecisionResponse(TypedDict, total=False):
+    """Shape returned by ``decisions.create``.
+
+    Without ``wait`` the API returns immediately with ``status`` "pending" and
+    ``answered`` False. With ``wait`` it may already carry the resolved
+    ``value`` when the human answered inside the window, or a ``hint`` telling
+    you to poll ``pollUrl`` if it did not.
+    """
+
+    decisionId: str
+    question: str
+    type: DecisionType
+    decisionPageUrl: str
+    pollUrl: str
+    expiresInSeconds: int
+    status: DecisionStatus
+    answered: bool
+    value: Optional[str]
+    hint: str
+
+
+class Decision(TypedDict, total=False):
+    """Shape returned by ``decisions.get``, the durable view of one decision."""
+
+    decisionId: str
+    status: DecisionStatus
+    answered: bool
+    value: Optional[str]
+    type: DecisionType
+    question: str
+    options: Optional[List[str]]
+    externalId: Optional[str]
+    createdAt: str
+    answeredAt: Optional[str]
+    expiresAt: Optional[str]
+
+
+class CancelDecisionResponse(TypedDict, total=False):
+    """Shape returned by ``decisions.cancel``."""
+
+    decisionId: str
+    cancelled: bool
+    status: DecisionStatus
+
+
+class WebhookSecretResponse(TypedDict, total=False):
+    """Shape returned by ``decisions.get_webhook_secret`` and
+    ``decisions.rotate_webhook_secret``.
+    """
+
+    secret: str

pushary/client.py

@@ -0,0 +1,116 @@
+"""The Pushary server client.
+
+Zero dependencies: the transport is stdlib ``urllib.request`` and JSON is parsed
+with stdlib ``json``. Construct once with your full API key and reuse the frozen
+instance across calls.
+"""
+
+from __future__ import annotations
+
+import json
+import urllib.error
+import urllib.request
+from typing import Any, Dict, Optional
+from urllib.parse import urlencode
+
+from .decisions import DecisionsResource
+from .errors import PusharyError
+
+DEFAULT_BASE_URL = "https://pushary.com/api/v1/server"
+
+# The create call and get(wait=N) can hold the connection open while a human
+# answers. The server caps that wait around 55s, so the socket timeout sits a
+# little above it to leave room for the round trip without hanging forever.
+DEFAULT_TIMEOUT_SECONDS = 65.0
+
+_SETTINGS_URL = "https://pushary.com/dashboard/settings"
+
+
+class PusharyServer:
+    """Client for the Pushary human-in-the-loop decisions API.
+
+    Args:
+        api_key: The full API key in the form ``pk_xxx.sk_xxx``.
+        base_url: Override the API base URL. Defaults to the public endpoint.
+
+    Raises:
+        ValueError: If the API key is empty or is missing the secret half.
+    """
+
+    def __init__(self, api_key: str, base_url: Optional[str] = None) -> None:
+        self._validate_api_key(api_key)
+
+        self._base_url = (base_url or DEFAULT_BASE_URL).rstrip("/")
+        self._headers: Dict[str, str] = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {api_key}",
+        }
+        self._timeout = DEFAULT_TIMEOUT_SECONDS
+        self.decisions = DecisionsResource(self._request)
+
+    @staticmethod
+    def _validate_api_key(api_key: str) -> None:
+        if not api_key:
+            raise ValueError(
+                f"API key is required. Get your API key from {_SETTINGS_URL}"
+            )
+        if "." not in api_key:
+            raise ValueError(
+                "Invalid API key format. Use the full API key (pk_xxx.sk_xxx). "
+                f"Get your API key from {_SETTINGS_URL}"
+            )
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        body: Optional[Dict[str, Any]] = None,
+        params: Optional[Dict[str, Any]] = None,
+    ) -> Dict[str, Any]:
+        url = self._base_url + path
+        if params:
+            query = {k: v for k, v in params.items() if v is not None}
+            if query:
+                url = f"{url}?{urlencode(query)}"
+
+        data = json.dumps(body).encode("utf-8") if body is not None else None
+        request = urllib.request.Request(
+            url, data=data, method=method, headers=dict(self._headers)
+        )
+
+        try:
+            with urllib.request.urlopen(request, timeout=self._timeout) as response:
+                raw = response.read()
+        except urllib.error.HTTPError as exc:
+            raise self._error_from_http(exc) from None
+        except urllib.error.URLError as exc:
+            raise PusharyError(f"Request to Pushary failed: {exc.reason}") from exc
+
+        return self._parse_json(raw)
+
+    @staticmethod
+    def _error_from_http(exc: urllib.error.HTTPError) -> PusharyError:
+        status = exc.code
+        message: Optional[str] = None
+        try:
+            parsed = json.loads(exc.read().decode("utf-8"))
+            if isinstance(parsed, dict):
+                error = parsed.get("error")
+                fallback = parsed.get("message")
+                message = error if isinstance(error, str) else None
+                if message is None and isinstance(fallback, str):
+                    message = fallback
+        except Exception:
+            message = None
+        return PusharyError(message or f"HTTP {status}", status=status)
+
+    @staticmethod
+    def _parse_json(raw: bytes) -> Dict[str, Any]:
+        if not raw:
+            return {}
+        try:
+            parsed = json.loads(raw.decode("utf-8"))
+        except (ValueError, UnicodeDecodeError):
+            return {}
+        return parsed if isinstance(parsed, dict) else {"data": parsed}

pushary/decisions.py

@@ -0,0 +1,120 @@
+"""Decisions resource: create, poll, answer, and cancel human-in-the-loop
+decisions, plus manage the webhook secret.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Callable, Dict, List, Optional
+from urllib.parse import quote
+
+RequestFn = Callable[..., Dict[str, Any]]
+
+class DecisionsResource:
+    """Ask a specific end-user to approve something, then resume on their answer.
+
+    Obtain an instance from ``PusharyServer(...).decisions``. Every method
+    returns the parsed JSON body as a ``dict`` and raises ``PusharyError`` on a
+    non-2xx response.
+    """
+
+    def __init__(self, request: RequestFn) -> None:
+        self._request = request
+
+    def create(
+        self,
+        question: str,
+        *,
+        type: str = "confirm",
+        options: Optional[List[str]] = None,
+        external_id: Optional[str] = None,
+        callback_url: Optional[str] = None,
+        agent_name: Optional[str] = None,
+        context: Optional[str] = None,
+        placeholder: Optional[str] = None,
+        expires_in_seconds: Optional[int] = None,
+        wait: Optional[bool] = None,
+        timeout_seconds: Optional[int] = None,
+        idempotency_key: Optional[str] = None,
+        powered_by: Optional[bool] = None,
+    ) -> Dict[str, Any]:
+        """Create a decision and ask one end-user to approve it.
+
+        Defaults to async (returns immediately with a decisionId); pass
+        wait=True to block up to ~55s for a fast answer. Always pass
+        idempotency_key so a retried call does not ask the same human twice.
+
+        ``type`` is "confirm" (yes/no), "select" (needs ``options``), or "input"
+        (free text). ``external_id`` targets the specific end-user to notify.
+        ``callback_url`` receives the signed webhook when the human answers.
+        ``expires_in_seconds`` sets how long the decision stays open.
+        ``timeout_seconds`` bounds the server-side wait when ``wait`` is True.
+
+        Returns a dict with ``decisionId``, ``pollUrl``, ``decisionPageUrl``, and
+        the current ``status``.
+        """
+
+        # Wire keys are camelCase even though the arguments are snake_case, and
+        # only keys with a value are sent so unset options stay absent.
+        body: Dict[str, Any] = {"question": question, "type": type}
+        optional = {
+            "options": options,
+            "externalId": external_id,
+            "callbackUrl": callback_url,
+            "agentName": agent_name,
+            "context": context,
+            "placeholder": placeholder,
+            "expiresInSeconds": expires_in_seconds,
+            "wait": wait,
+            "timeoutSeconds": timeout_seconds,
+            "idempotencyKey": idempotency_key,
+            "poweredBy": powered_by,
+        }
+        for key, value in optional.items():
+            if value is not None:
+                body[key] = value
+        return self._request("POST", "/decisions", body=body)
+
+    def get(self, decision_id: str, *, wait: Optional[int] = None) -> Dict[str, Any]:
+        """Fetch the current state of a decision.
+
+        Pass wait=N to long-poll for up to N seconds (capped server-side around
+        55s) so the call returns as soon as the human answers instead of on the
+        next poll. Returns a dict with ``status``, ``answered``, and ``value``.
+        """
+
+        params = {"wait": wait} if wait is not None else None
+        return self._request("GET", f"/decisions/{_seg(decision_id)}", params=params)
+
+    def answer(self, decision_id: str, answer: str) -> Dict[str, Any]:
+        """Record an answer for a decision on the human's behalf.
+
+        Useful when your own surface (not the Pushary decision page) collected
+        the answer. Any waiting ``get`` or ``create`` call resolves immediately.
+        """
+
+        return self._request("POST", f"/decisions/{_seg(decision_id)}", body={"answer": answer})
+
+    def cancel(self, decision_id: str) -> Dict[str, Any]:
+        """Cancel a still-open decision so it can no longer be answered."""
+
+        return self._request("DELETE", f"/decisions/{_seg(decision_id)}")
+
+    def get_webhook_secret(self) -> Dict[str, Any]:
+        """Return the current webhook secret used to sign decision callbacks."""
+
+        return self._request("GET", "/webhook-secret")
+
+    def rotate_webhook_secret(self) -> Dict[str, Any]:
+        """Rotate the webhook secret and return the new value.
+
+        The previous secret stops verifying once rotated, so update every
+        receiver before you rely on the new one.
+        """
+
+        return self._request("POST", "/webhook-secret")
+
+
+def _seg(value: str) -> str:
+    """Percent-encode a single path segment so an id cannot alter the route."""
+
+    return quote(str(value), safe="")

pushary/errors.py

@@ -0,0 +1,22 @@
+"""Error type raised by the Pushary SDK."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+
+class PusharyError(Exception):
+    """Raised when the Pushary API returns a non-2xx response.
+
+    Carries the HTTP ``status`` and the reason the server reported (its
+    ``error`` or ``message`` field), so callers can classify the failure
+    instead of parsing a bare status code.
+    """
+
+    def __init__(self, message: str, status: Optional[int] = None) -> None:
+        super().__init__(message)
+        self.message = message
+        self.status = status
+
+    def __repr__(self) -> str:
+        return f"PusharyError(status={self.status!r}, message={self.message!r})"

pushary/webhook.py

@@ -0,0 +1,53 @@
+"""Webhook signature verification.
+
+When a human answers a decision, Pushary can POST the result to your
+``callback_url``. The request carries an ``X-Pushary-Signature`` header, which is
+an HMAC-SHA256 hex digest computed over the raw request body using your webhook
+secret. Verify it before you trust the payload.
+"""
+
+from __future__ import annotations
+
+import hashlib
+import hmac
+from typing import Optional, Union
+
+SIGNATURE_HEADER = "X-Pushary-Signature"
+"""Name of the header that carries the signature on inbound webhooks."""
+
+
+def _to_bytes(value: Union[str, bytes]) -> bytes:
+    """Encode a value to bytes with utf-8, leaving bytes untouched."""
+
+    if isinstance(value, bytes):
+        return value
+    return value.encode("utf-8")
+
+
+def verify_webhook_signature(
+    raw_body: Union[str, bytes],
+    signature: Optional[str],
+    secret: str,
+) -> bool:
+    """Return True only if ``signature`` is a valid signature for ``raw_body``.
+
+    Compute ``hmac.new(secret, raw_body, sha256).hexdigest()`` and compare it to
+    the ``X-Pushary-Signature`` header in constant time. ``raw_body`` must be the
+    exact bytes you received, not a re-serialized copy, because any change to the
+    JSON (key order, spacing) changes the digest.
+
+    Returns False when either ``signature`` or ``secret`` is empty, or when the
+    lengths do not match, before doing the constant-time compare.
+    """
+
+    if not signature or not secret:
+        return False
+
+    expected = hmac.new(_to_bytes(secret), _to_bytes(raw_body), hashlib.sha256).hexdigest()
+    expected_bytes = expected.encode("ascii")
+    provided_bytes = _to_bytes(signature)
+
+    if len(expected_bytes) != len(provided_bytes):
+        return False
+
+    return hmac.compare_digest(expected_bytes, provided_bytes)

pushary-1.1.0.dist-info/METADATA

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: pushary
+Version: 1.1.0
+Summary: Human-in-the-loop decisions SDK for Pushary: create a decision, ask a specific end-user to approve, and resume on their answer via webhook or poll.
+Project-URL: Homepage, https://pushary.com
+Project-URL: Documentation, https://pushary.com/docs
+Author-email: Pushary <aadil@pushary.com>
+Maintainer-email: Pushary <aadil@pushary.com>
+License: MIT
+License-File: LICENSE
+Keywords: ai-agents,approvals,human-in-the-loop,notifications,webhooks
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# pushary
+
+Human-in-the-loop decisions for AI products, in Python. Create a decision, ask a
+specific end-user to approve it, and resume on their answer via webhook or poll.
+
+This is the Python counterpart of the `@pushary/server` SDK. It is zero
+dependency (Python standard library only) and targets Python 3.9 and newer.
+
+## Installation
+
+```bash
+pip install pushary
+```
+
+## API key
+
+The SDK needs your full API key (`pk_xxx.sk_xxx`), which includes the secret
+half. Never expose it in client-side code. Get your key from your
+[Pushary dashboard](https://pushary.com/dashboard/settings).
+
+```python
+import os
+from pushary import PusharyServer
+
+pushary = PusharyServer(api_key=os.environ["PUSHARY_API_KEY"])
+```
+
+## Human-in-the-loop decisions
+
+A decision asks one of your end-users to approve something and then lets your
+product resume once they answer. Use it for the moments where a human should be
+in the loop: releasing funds, sending an outbound message, running a
+destructive action, or confirming an AI-proposed change.
+
+The flow has three parts:
+
+1. Create a decision and notify the end-user.
+2. Resume when they answer, either by handling the webhook or by polling.
+3. Optionally answer or cancel on their behalf from your own surface.
+
+### Create a decision
+
+By default `create` is async: it returns right away with a `decisionId` and a
+`pollUrl`, which suits serverless functions that cannot hold a request open
+while a human decides. Pass `wait=True` to block for up to about 55 seconds in
+case the human answers quickly.
+
+Always pass `idempotency_key` so a retried call does not ask the same human
+twice.
+
+```python
+decision = pushary.decisions.create(
+    "Approve the $4,200 payout to Acme Corp?",
+    type="confirm",
+    external_id="user_123",
+    agent_name="Billing Agent",
+    context="Invoice INV-8842, net-30, first payout to this vendor.",
+    callback_url="https://your-app.com/webhooks/pushary",
+    expires_in_seconds=3600,
+    wait=True,
+    timeout_seconds=50,
+    idempotency_key="payout-INV-8842",
+)
+
+if decision["answered"]:
+    print("Resolved fast:", decision["value"])
+else:
+    print("Still pending, poll:", decision["pollUrl"])
+```
+
+For a multiple choice decision, pass `type="select"` with at least two
+`options`. For free text, pass `type="input"` and an optional `placeholder`.
+
+```python
+decision = pushary.decisions.create(
+    "Which shipping speed should we book?",
+    type="select",
+    options=["Standard", "Express", "Overnight"],
+    external_id="user_123",
+)
+```
+
+### Poll for the answer
+
+If you did not wait, or the wait window closed before the human answered, poll
+for the outcome. Pass `wait=N` to long-poll for up to N seconds so the call
+returns as soon as they answer rather than on your next loop.
+
+```python
+result = pushary.decisions.get(decision["decisionId"], wait=50)
+
+if result["status"] == "answered":
+    print("Answer:", result["value"])
+elif result["status"] == "expired":
+    print("The decision expired before anyone answered.")
+```
+
+### Answer or cancel on their behalf
+
+If your own interface collected the answer, record it so any waiting call
+resolves. Cancel a decision to close it when it is no longer needed.
+
+```python
+pushary.decisions.answer(decision["decisionId"], "yes")
+
+pushary.decisions.cancel(decision["decisionId"])
+```
+
+## Webhooks
+
+When the end-user answers, Pushary POSTs the result to your `callback_url`. The
+request carries an `X-Pushary-Signature` header, an HMAC-SHA256 hex digest of
+the raw request body signed with your webhook secret. Verify it against the raw
+bytes you received, before parsing the JSON, so a change to spacing or key order
+cannot slip past the check.
+
+Fetch or rotate the secret from the SDK:
+
+```python
+secret = pushary.decisions.get_webhook_secret()
+rotated = pushary.decisions.rotate_webhook_secret()
+```
+
+A Flask handler that verifies the signature and resumes your work:
+
+```python
+import os
+from flask import Flask, request, abort
+from pushary import verify_webhook_signature
+
+app = Flask(__name__)
+WEBHOOK_SECRET = os.environ["PUSHARY_WEBHOOK_SECRET"]
+
+@app.post("/webhooks/pushary")
+def pushary_webhook():
+    signature = request.headers.get("X-Pushary-Signature")
+    if not verify_webhook_signature(request.data, signature, WEBHOOK_SECRET):
+        abort(401)
+
+    payload = request.get_json()
+    decision_id = payload["decisionId"]
+    answer = payload.get("value")
+    # Resume your work now that the human has answered.
+    return "", 204
+```
+
+`request.data` is the raw request body Flask captured, which is exactly what the
+signature was computed over. Do not re-serialize the parsed JSON before
+verifying.
+
+## Errors
+
+Every method returns the parsed JSON body as a `dict`. A non-2xx response raises
+`PusharyError`, which carries the HTTP `status` and the reason the server
+reported.
+
+```python
+from pushary import PusharyError
+
+try:
+    pushary.decisions.get("does-not-exist")
+except PusharyError as error:
+    print(error.status, error.message)
+```
+
+## Security
+
+- Keep your API key and webhook secret in environment variables.
+- Rotate the webhook secret from the dashboard or via
+  `rotate_webhook_secret()` if it is ever exposed.
+- API keys are site-scoped, so a key can only reach its own decisions.
+
+## License
+
+MIT. See `LICENSE`.

pushary-1.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pushary/__init__.py,sha256=LcMqZXHB9q_B011jz-iwzg9K_ciaHBA8P6VA5qIOHOU,913
+pushary/_types.py,sha256=bmFxikuPUWGWK1hyjj7dGeS5IPYQ1OxNC35KQxJP2zM,2204
+pushary/client.py,sha256=qH5B2Idm4IJpxwyVLhp0DI8zUM733d-frWLCysmEl1k,4034
+pushary/decisions.py,sha256=Qk1YFjn9iI31FHkMwxTOt9Sr-1hN03RazstVlnAaMGM,4730
+pushary/errors.py,sha256=WrZFxTfYmt8c3v9cibkyyCaytAJ_L9x5oAS2lJT3T1w,686
+pushary/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pushary/webhook.py,sha256=1BSTQG4RMNwyWMyafg0B3Q85ONtnmHd9YuWMEmK9R1s,1774
+pushary-1.1.0.dist-info/METADATA,sha256=0gmzxs3-bOIe_rET8p-9M5-_HztJanp_pMrnyDoTL9c,6434
+pushary-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pushary-1.1.0.dist-info/licenses/LICENSE,sha256=dbAOXev8njZg4qMsS4LS9tZq8cVgKYPZ1iTeOux9UBE,1064
+pushary-1.1.0.dist-info/RECORD,,

pushary-1.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pushary-1.1.0.dist-info/licenses/LICENSE

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