postq-sdk 0.2.0

Official PostQ SDK for Python — submit quantum-risk scans and read results from the PostQ API.

postq-sdk

Official PostQ SDK for Python. Submit quantum-risk scans and read results from the PostQ API.

pip install postq-sdk

Quickstart

from postq import PostQ, Finding

pq = PostQ(api_key="pq_live_…")  # or set POSTQ_API_KEY env var

# Submit a scan
result = pq.scans.submit(
    type="url",
    target="example.com",
    risk_score=85,
    risk_level="High",
    findings=[
        Finding(severity="high", title="RSA-2048 public key"),
    ],
)
print(result.url)  # https://app.postq.dev/scans/...

# List recent scans
for scan in pq.scans.list(limit=10):
    print(scan.target, scan.risk_level)

# Iterate every scan with automatic pagination
for scan in pq.scans.iter_all():
    ...

Configuration

Argument	Default	Notes
api_key	$POSTQ_API_KEY	pq_live_… from your dashboard
base_url	https://api.postq.dev	Override for staging or self-hosted
timeout	30.0	Per-request timeout in seconds
max_retries	3	Retries on 429/5xx with backoff

Errors

All exceptions extend PostQError:

from postq import PostQ, PostQAuthError, PostQRateLimitError

try:
    pq.scans.list()
except PostQAuthError:
    print("bad API key")
except PostQRateLimitError:
    print("slow down")

Exception	When
PostQConfigError	Missing/invalid constructor input
PostQAuthError	401 — bad, revoked, or expired key
PostQNotFoundError	404
PostQRateLimitError	429
PostQServerError	5xx
PostQNetworkError	DNS, connection refused, timeout
PostQError	Base class

Requirements

• Python 3.9+
• Single dependency: requests

License

MIT — see LICENSE.