signyt 0.2.0__tar.gz

signyt-0.2.0/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+dist/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/

signyt-0.2.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: signyt
+Version: 0.2.0
+Summary: Official Python SDK for the sign.yt e-signature API
+License-Expression: MIT
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.6
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# signyt (Python)
+
+Typed sync + async client for the [sign.yt](https://sign.yt) REST API. Python 3.10+, depends on `httpx` and `pydantic` v2.
+
+```bash
+pip install signyt
+```
+
+## Quickstart
+
+Create an API key in the app (`/app/api-keys`) with `documents:read` + `documents:write` (and `webhooks:manage` for webhooks).
+
+```python
+from signyt import Signyt
+
+with Signyt("sk_live_...", base_url="https://sign.yt/api/v1") as s:
+    # 1. create a draft from a PDF, with a signer
+    doc = s.documents.create(
+        "contract.pdf",
+        title="Service agreement",
+        recipients=[{"email": "jan@acme.pl", "name": "Jan Kowalski"}],
+        verification_type="EMAIL_OTP",
+    )
+
+    # 2. place a signature field for that signer (positions are % of the page)
+    s.documents.set_fields(doc.id, [{
+        "type": "SIGNATURE", "page": 1, "position_x": 15, "position_y": 80,
+        "width": 25, "height": 8, "recipient_id": doc.recipients[0].id,
+    }])
+
+    # 3. send
+    s.documents.send(doc.id)
+
+    # 4. subscribe once; then wait for the webhook (below) instead of polling
+    s.webhooks.create("https://yourapp.com/hooks/signyt", ["document.completed"])
+```
+
+Async: `async with AsyncSignyt("sk_live_...") as s: await s.documents.send(id)`.
+
+### Receive the webhook
+
+Deliveries carry `X-Signyt-Signature: sha256=<hex>` and `X-Signyt-Timestamp`; the HMAC input is
+`<timestamp>.<raw body>`. Pass the **raw** body bytes:
+
+```python
+from signyt.webhooks import construct_event   # or verify_signature(payload, sig, secret, ts)
+
+@app.post("/hooks/signyt")
+async def hook(request: Request):
+    event = construct_event(await request.body(), request.headers, WEBHOOK_SECRET)
+    if event["event"] == "document.completed":
+        pdf = s.documents.download_signed_pdf(event["data"]["document_id"])
+```
+
+`SignatureVerificationError` is raised on a bad signature or a timestamp older than `tolerance` (default 300 s).
+
+## Errors and retries
+
+All errors derive from `SignytError` (`.status`, `.code`, `.message`, `.extra`, `.request_id`):
+`AuthenticationError` 401, `PaymentRequiredError` 402, `PermissionDeniedError` 403, `NotFoundError` 404,
+`BadRequestError` 400/413/422, `RateLimitError` 429 (`.retry_after`), `ServerError` 5xx, `APIConnectionError`.
+
+`GET`/`PUT`/`DELETE` are retried on 429, 5xx and network errors (`max_retries=2`, honours `Retry-After`,
+else exponential backoff). `POST`/`PATCH` are never retried automatically.
+
+## Resources
+
+`documents`: list, get, create, set_fields, detect_fields, update_recipient, resend, send, cancel, remind,
+delete, restore, download_signed_pdf, download_original_pdf, audit.
+`templates`: list, create, use, delete. `webhooks`: list, create, update, delete.
+
+Response models live in `signyt.models` and are generated from the OpenAPI spec (`make sdk.generate`).

signyt-0.2.0/README.md

@@ -0,0 +1,72 @@
+# signyt (Python)
+
+Typed sync + async client for the [sign.yt](https://sign.yt) REST API. Python 3.10+, depends on `httpx` and `pydantic` v2.
+
+```bash
+pip install signyt
+```
+
+## Quickstart
+
+Create an API key in the app (`/app/api-keys`) with `documents:read` + `documents:write` (and `webhooks:manage` for webhooks).
+
+```python
+from signyt import Signyt
+
+with Signyt("sk_live_...", base_url="https://sign.yt/api/v1") as s:
+    # 1. create a draft from a PDF, with a signer
+    doc = s.documents.create(
+        "contract.pdf",
+        title="Service agreement",
+        recipients=[{"email": "jan@acme.pl", "name": "Jan Kowalski"}],
+        verification_type="EMAIL_OTP",
+    )
+
+    # 2. place a signature field for that signer (positions are % of the page)
+    s.documents.set_fields(doc.id, [{
+        "type": "SIGNATURE", "page": 1, "position_x": 15, "position_y": 80,
+        "width": 25, "height": 8, "recipient_id": doc.recipients[0].id,
+    }])
+
+    # 3. send
+    s.documents.send(doc.id)
+
+    # 4. subscribe once; then wait for the webhook (below) instead of polling
+    s.webhooks.create("https://yourapp.com/hooks/signyt", ["document.completed"])
+```
+
+Async: `async with AsyncSignyt("sk_live_...") as s: await s.documents.send(id)`.
+
+### Receive the webhook
+
+Deliveries carry `X-Signyt-Signature: sha256=<hex>` and `X-Signyt-Timestamp`; the HMAC input is
+`<timestamp>.<raw body>`. Pass the **raw** body bytes:
+
+```python
+from signyt.webhooks import construct_event   # or verify_signature(payload, sig, secret, ts)
+
+@app.post("/hooks/signyt")
+async def hook(request: Request):
+    event = construct_event(await request.body(), request.headers, WEBHOOK_SECRET)
+    if event["event"] == "document.completed":
+        pdf = s.documents.download_signed_pdf(event["data"]["document_id"])
+```
+
+`SignatureVerificationError` is raised on a bad signature or a timestamp older than `tolerance` (default 300 s).
+
+## Errors and retries
+
+All errors derive from `SignytError` (`.status`, `.code`, `.message`, `.extra`, `.request_id`):
+`AuthenticationError` 401, `PaymentRequiredError` 402, `PermissionDeniedError` 403, `NotFoundError` 404,
+`BadRequestError` 400/413/422, `RateLimitError` 429 (`.retry_after`), `ServerError` 5xx, `APIConnectionError`.
+
+`GET`/`PUT`/`DELETE` are retried on 429, 5xx and network errors (`max_retries=2`, honours `Retry-After`,
+else exponential backoff). `POST`/`PATCH` are never retried automatically.
+
+## Resources
+
+`documents`: list, get, create, set_fields, detect_fields, update_recipient, resend, send, cancel, remind,
+delete, restore, download_signed_pdf, download_original_pdf, audit.
+`templates`: list, create, use, delete. `webhooks`: list, create, update, delete.
+
+Response models live in `signyt.models` and are generated from the OpenAPI spec (`make sdk.generate`).

signyt-0.2.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "signyt"
+version = "0.2.0"
+description = "Official Python SDK for the sign.yt e-signature API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = ["httpx>=0.27", "pydantic>=2.6"]
+classifiers = ["Typing :: Typed"]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "pytest-asyncio>=0.23", "respx>=0.21", "mypy>=1.10"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/signyt"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.mypy]
+strict = true
+exclude = ["_models\\.py"]

signyt-0.2.0/src/signyt/__init__.py

@@ -0,0 +1,27 @@
+"""sign.yt Python SDK."""
+
+from . import _models as models
+from . import webhooks
+from .client import AsyncSignyt, Signyt
+from .errors import (
+    APIConnectionError,
+    AuthenticationError,
+    BadRequestError,
+    ConflictError,
+    NotFoundError,
+    PaymentRequiredError,
+    PermissionDeniedError,
+    RateLimitError,
+    ServerError,
+    SignatureVerificationError,
+    SignytError,
+)
+from .types import FieldInput, RecipientInput
+
+__version__ = "0.2.0"
+__all__ = [
+    "Signyt", "AsyncSignyt", "models", "webhooks", "RecipientInput", "FieldInput",
+    "SignytError", "APIConnectionError", "AuthenticationError", "BadRequestError",
+    "ConflictError", "NotFoundError", "PaymentRequiredError", "PermissionDeniedError",
+    "RateLimitError", "ServerError", "SignatureVerificationError",
+]