signwell-sdk-python 0.1.0__tar.gz

signwell_sdk_python-0.1.0/LICENSE

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

signwell_sdk_python-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: signwell-sdk-python
+Version: 0.1.0
+Summary: Python SDK for the SignWell API
+Keywords: signwell,esignature,api,sdk
+Author: SignWell
+Author-email: SignWell <support@signwell.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Typing :: Typed
+Requires-Dist: pydantic>=2,<3
+Requires-Dist: python-dateutil>=2.8.2,<3
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: urllib3>=1.26.18,<3
+Requires-Python: >=3.10
+Project-URL: Documentation, https://developers.signwell.com
+Project-URL: Homepage, https://www.signwell.com
+Project-URL: Issues, https://github.com/Bidsketch/signwell-sdk-python/issues
+Project-URL: Repository, https://github.com/Bidsketch/signwell-sdk-python
+Description-Content-Type: text/markdown
+
+# SignWell Python SDK
+
+Python SDK for the SignWell API.
+
+This package is generated from the SignWell OpenAPI spec by
+`Bidsketch/signwell-sdk-generator`. Do not edit generated SDK runtime files
+directly; make durable changes in the generator repo.
+
+## Installation
+
+```bash
+pip install signwell-sdk-python
+```
+
+With uv:
+
+```bash
+uv add signwell-sdk-python
+```
+
+## Quick Start
+
+```python
+import os
+
+import signwell_sdk
+from signwell_sdk.api.document_api import DocumentApi
+
+configuration = signwell_sdk.Configuration(
+    api_key={"api_key": os.environ["SIGNWELL_API_KEY"]}
+)
+
+with signwell_sdk.ApiClient(configuration) as api_client:
+    documents = DocumentApi(api_client)
+    document = documents.get_document("document-id")
+    print(document.id)
+```
+
+The SDK sends the API key in the `X-Api-Key` header. The default host is
+`https://www.signwell.com`.
+
+## Resources, Models, And Errors
+
+The generated resource clients are available from their generated modules and
+from the parity namespace:
+
+```python
+documents = signwell_sdk.Resources.DocumentApi(api_client)
+model_cls = signwell_sdk.Models.DocumentResponse
+not_found_cls = signwell_sdk.Errors.NotFoundError
+```
+
+Status-specific errors inherit from `signwell_sdk.ApiException`:
+
+```python
+try:
+    documents.get_document("missing")
+except signwell_sdk.Errors.NotFoundError as exc:
+    print(exc.status)
+    print(exc.data or exc.body)
+```
+
+## Binary And JSON Responses
+
+Some endpoints can return either JSON or binary data. The SDK selects the
+correct `Accept` header from the mode parameters.
+
+```python
+from signwell_sdk.api.bulk_send_api import BulkSendApi
+from signwell_sdk.api.regional_api import RegionalApi
+
+bulk_send = BulkSendApi(api_client)
+csv_bytes = bulk_send.get_bulk_send_csv_template(
+    ["00000000-0000-0000-0000-000000000000"]
+)
+csv_json = bulk_send.get_bulk_send_csv_template(
+    ["00000000-0000-0000-0000-000000000000"],
+    var_base64=True,
+)
+
+documents = DocumentApi(api_client)
+pdf_bytes = documents.get_completed_pdf("doc_123")
+pdf_url = documents.get_completed_pdf("doc_123", url_only=True)
+
+regional = RegionalApi(api_client)
+certificate_bytes = regional.get_nom151_certificate("doc_123")
+certificate_url = regional.get_nom151_certificate("doc_123", url_only=True)
+certificate_object = regional.get_nom151_certificate("doc_123", object_only=True)
+```
+
+## Embedded Helpers
+
+```python
+doc = signwell_sdk.Embedded.create_signing_document(
+    name="NDA",
+    files=[{"name": "nda.pdf", "file_base64": "JVBERi0xLjQK"}],
+    recipients=[{"name": "Jane Doe", "email": "jane@example.com"}],
+    fields=[[{"x": 20, "y": 60, "page": 1, "type": "signature"}]],
+    options={"api_client": api_client},
+)
+
+url = signwell_sdk.Embedded.embedded_signing_url(doc)
+```
+
+Embedded signing documents must include fields for every recipient, set
+`with_signature_page=True`, or set `text_tags=True`.
+
+## Webhook Verification
+
+```python
+payload = request.json()
+event = payload["event"]
+
+signwell_sdk.Webhook.verify_event_or_raise(
+    event=event,
+    webhook_id=os.environ["SIGNWELL_WEBHOOK_ID"],
+    tolerance_seconds=300,
+)
+```
+
+For side-effecting handlers, use replay-aware verification with an atomic store:
+
+```python
+store = signwell_sdk.Webhook.MemoryReplayStore()
+
+signwell_sdk.Webhook.verify_event_once_or_raise(
+    event=event,
+    webhook_id=os.environ["SIGNWELL_WEBHOOK_ID"],
+    tolerance_seconds=300,
+    replay_store=store,
+)
+```
+
+`MemoryReplayStore` is intended for local development and single-process apps.
+Production apps should use a shared atomic store such as Redis or a database
+table with a uniqueness constraint.
+
+## Local Package Build
+
+```bash
+uv sync --dev
+uv run pytest
+uv build --no-sources
+```
+
+`uv build --no-sources` verifies that the source distribution and wheel can be
+built from publishable package metadata.

signwell_sdk_python-0.1.0/README.md

@@ -0,0 +1,147 @@
+# SignWell Python SDK
+
+Python SDK for the SignWell API.
+
+This package is generated from the SignWell OpenAPI spec by
+`Bidsketch/signwell-sdk-generator`. Do not edit generated SDK runtime files
+directly; make durable changes in the generator repo.
+
+## Installation
+
+```bash
+pip install signwell-sdk-python
+```
+
+With uv:
+
+```bash
+uv add signwell-sdk-python
+```
+
+## Quick Start
+
+```python
+import os
+
+import signwell_sdk
+from signwell_sdk.api.document_api import DocumentApi
+
+configuration = signwell_sdk.Configuration(
+    api_key={"api_key": os.environ["SIGNWELL_API_KEY"]}
+)
+
+with signwell_sdk.ApiClient(configuration) as api_client:
+    documents = DocumentApi(api_client)
+    document = documents.get_document("document-id")
+    print(document.id)
+```
+
+The SDK sends the API key in the `X-Api-Key` header. The default host is
+`https://www.signwell.com`.
+
+## Resources, Models, And Errors
+
+The generated resource clients are available from their generated modules and
+from the parity namespace:
+
+```python
+documents = signwell_sdk.Resources.DocumentApi(api_client)
+model_cls = signwell_sdk.Models.DocumentResponse
+not_found_cls = signwell_sdk.Errors.NotFoundError
+```
+
+Status-specific errors inherit from `signwell_sdk.ApiException`:
+
+```python
+try:
+    documents.get_document("missing")
+except signwell_sdk.Errors.NotFoundError as exc:
+    print(exc.status)
+    print(exc.data or exc.body)
+```
+
+## Binary And JSON Responses
+
+Some endpoints can return either JSON or binary data. The SDK selects the
+correct `Accept` header from the mode parameters.
+
+```python
+from signwell_sdk.api.bulk_send_api import BulkSendApi
+from signwell_sdk.api.regional_api import RegionalApi
+
+bulk_send = BulkSendApi(api_client)
+csv_bytes = bulk_send.get_bulk_send_csv_template(
+    ["00000000-0000-0000-0000-000000000000"]
+)
+csv_json = bulk_send.get_bulk_send_csv_template(
+    ["00000000-0000-0000-0000-000000000000"],
+    var_base64=True,
+)
+
+documents = DocumentApi(api_client)
+pdf_bytes = documents.get_completed_pdf("doc_123")
+pdf_url = documents.get_completed_pdf("doc_123", url_only=True)
+
+regional = RegionalApi(api_client)
+certificate_bytes = regional.get_nom151_certificate("doc_123")
+certificate_url = regional.get_nom151_certificate("doc_123", url_only=True)
+certificate_object = regional.get_nom151_certificate("doc_123", object_only=True)
+```
+
+## Embedded Helpers
+
+```python
+doc = signwell_sdk.Embedded.create_signing_document(
+    name="NDA",
+    files=[{"name": "nda.pdf", "file_base64": "JVBERi0xLjQK"}],
+    recipients=[{"name": "Jane Doe", "email": "jane@example.com"}],
+    fields=[[{"x": 20, "y": 60, "page": 1, "type": "signature"}]],
+    options={"api_client": api_client},
+)
+
+url = signwell_sdk.Embedded.embedded_signing_url(doc)
+```
+
+Embedded signing documents must include fields for every recipient, set
+`with_signature_page=True`, or set `text_tags=True`.
+
+## Webhook Verification
+
+```python
+payload = request.json()
+event = payload["event"]
+
+signwell_sdk.Webhook.verify_event_or_raise(
+    event=event,
+    webhook_id=os.environ["SIGNWELL_WEBHOOK_ID"],
+    tolerance_seconds=300,
+)
+```
+
+For side-effecting handlers, use replay-aware verification with an atomic store:
+
+```python
+store = signwell_sdk.Webhook.MemoryReplayStore()
+
+signwell_sdk.Webhook.verify_event_once_or_raise(
+    event=event,
+    webhook_id=os.environ["SIGNWELL_WEBHOOK_ID"],
+    tolerance_seconds=300,
+    replay_store=store,
+)
+```
+
+`MemoryReplayStore` is intended for local development and single-process apps.
+Production apps should use a shared atomic store such as Redis or a database
+table with a uniqueness constraint.
+
+## Local Package Build
+
+```bash
+uv sync --dev
+uv run pytest
+uv build --no-sources
+```
+
+`uv build --no-sources` verifies that the source distribution and wheel can be
+built from publishable package metadata.

signwell_sdk_python-0.1.0/pyproject.toml

@@ -0,0 +1,104 @@
+[project]
+name = "signwell-sdk-python"
+version = "0.1.0"
+description = "Python SDK for the SignWell API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+  { name = "SignWell", email = "support@signwell.com" }
+]
+keywords = ["signwell", "esignature", "api", "sdk"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed"
+]
+dependencies = [
+  "pydantic>=2,<3",
+  "python-dateutil>=2.8.2,<3",
+  "typing-extensions>=4.7.1",
+  "urllib3>=1.26.18,<3"
+]
+
+[project.urls]
+Homepage = "https://www.signwell.com"
+Repository = "https://github.com/Bidsketch/signwell-sdk-python"
+Issues = "https://github.com/Bidsketch/signwell-sdk-python/issues"
+Documentation = "https://developers.signwell.com"
+
+[dependency-groups]
+dev = [
+  "mypy>=1.8",
+  "pytest>=8",
+  "ruff>=0.8",
+  "twine>=5",
+  "types-python-dateutil>=2.8.19.14"
+]
+
+[build-system]
+requires = ["uv_build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "signwell_sdk"
+module-root = ""
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+extend-exclude = [
+  ".openapi-generator",
+  "docs",
+  "test"
+]
+
+[tool.ruff.lint]
+select = ["B", "C4", "E", "F", "I", "SIM", "UP"]
+ignore = [
+  "B008",
+  "B904",
+  "C409",
+  "C405",
+  "E721",
+  "E501",
+  "F401",
+  "F811",
+  "I001",
+  "SIM101",
+  "SIM105",
+  "SIM118",
+  "SIM108",
+  "UP030",
+  "UP031",
+  "UP006",
+  "UP007",
+  "UP035"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["signwell_sdk", "tests"]
+exclude = ["^test/"]
+ignore_missing_imports = true
+follow_imports = "silent"
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true
+disallow_untyped_defs = false
+disallow_any_generics = false
+no_implicit_optional = true
+strict_equality = true