documentors 0.1.0

Python SDK for the DocuMentors document lifecycle management platform

DocuMentors Python SDK

Official Python SDK for the DocuMentors document lifecycle management API.

Installation

pip install documentors

Or install from source:

pip install -e sdk/python/

Quick Start

from documentors import DocumentorsClient

client = DocumentorsClient(
    base_url="https://your-instance.docu-mentors.com",
    api_key="dk_prod_your_key_here",
)

# Upload a document
doc = client.documents.upload("contract.pdf", title="Q2 Contract", classification="CONFIDENTIAL")

# Scan for PII
scan = client.security.detect_pii(doc.id)
for finding in scan.findings:
    print(f"{finding.type}: {finding.masked_value}")

client.close()

Authentication

API Key (recommended for integrations)

client = DocumentorsClient(base_url="...", api_key="dk_prod_xxx")

JWT (interactive / service-to-service)

client = DocumentorsClient(base_url="...")
client.login(email="[e-mail]", password="secret")

Context Manager

with DocumentorsClient(base_url="...", api_key="dk_prod_xxx") as client:
    docs = client.documents.list()

Resource Namespaces

Namespace	Description
client.documents	Upload, list, get, delete, versions, download
client.security	PII detection/redaction, phishing analysis
client.compliance	Legal holds, eDiscovery, retention policies
client.admin	Users, API keys, audit logs, devices

Error Handling

from documentors import DocumentorsClient, NotFoundError, RateLimitError

try:
    doc = client.documents.get("bad-id")
except NotFoundError:
    print("Document not found")
except RateLimitError as e:
    print(f"Rate limited — retry after {e.retry_after}s")

Exception Hierarchy

• DocumentorsError — base
  • AuthenticationError — 401
  • PermissionDeniedError — 403
  • NotFoundError — 404
  • ValidationError — 422
  • ConflictError — 409
  • RateLimitError — 429 (includes retry_after)
  • ServerError — 500+

Transport Features

• Automatic retry with exponential backoff on 429/5xx
• Retry-After header support
• Configurable timeout and max retries
• Clean error mapping from HTTP status codes

Examples

See examples/ for full working scripts:

• quickstart.py — Upload + PII scan + redaction
• bulk_upload.py — Batch upload with auto-scan
• pii_scan_pipeline.py — Full PII audit → CSV report
• compliance_report.py — Legal holds + retention summary

Development

pip install -e ".[dev]"
pytest

License

MIT