Skip to main content

Official-spec Skribble API v2 SDK (built from Skribble Postman collection)

Project description

Skribble SDK

A production-ready Python SDK for the Skribble API v2, generated from the official Skribble Postman collection.

Features

  • Authentication via /v2/access/login
  • JWT access token caching (default in-memory with optional Redis backend; default TTL: 20 minutes)
  • High-level clients for:
    • SignatureRequests
    • Documents
    • Seal
    • Send-to
    • User
    • Report (activities)
    • Monitoring (callbacks & system health)

Installation

pip install skribble

# If you want Redis-backed token caching
pip install "skribble[redis]"

Usage

from skribble import SkribbleClient

# Default: in-memory token cache (per-process)
client = SkribbleClient(
    username="api_demo_your_name",
    api_key="your_api_key",
)

# Optional: Redis-backed token cache (shared across processes)
import redis
r = redis.Redis(host="localhost", port=6379, db=0)
client = SkribbleClient(
    username="api_demo_your_name",
    api_key="your_api_key",
    redis_client=r,
)

# Upload a document
doc = client.documents.upload(
    title="Example contract PDF",
    content="<BASE64_PDF>",
)

# Create a signature request using that document
sr = client.signature_requests.create(
    title="Example contract",
    signatures=[{"account_email": "john.doe@skribble.com"}],
    document_id=doc["id"],
)

# List signature requests
srs = client.signature_requests.list(page_size=50)

# Token caching
# - Default in-memory cache (per process)
# - For shared caching use Redis (`pip install "skribble[redis]"`) and pass `redis_client`
# - You can also provide any cache object with `get(key)` and `setex(key, ttl_seconds, value)`

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skribble-0.2.0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skribble-0.2.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file skribble-0.2.0.tar.gz.

File metadata

  • Download URL: skribble-0.2.0.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for skribble-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3097d7d187d8024b0a63e91c54888a2af96f618b24fd99183f610cd3bd627ae7
MD5 fdfe2dc54d85467c29170e538ebe9599
BLAKE2b-256 37747e72c37eab33cdcd834a0b9c2fd2b6ed00d972a738492a02ddd8afddeb26

See more details on using hashes here.

File details

Details for the file skribble-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: skribble-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for skribble-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 035224d707e27ba5823ab9acb8466ec9d5a1182ac36fa87c1481659b88ac230a
MD5 4d4d607bf2d98a654933176ea5132b47
BLAKE2b-256 141945399c2f801bc203584f3a10231e97fec3d87bd98b46b7814d10c7f858f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page