scrubbe-sdk 1.0.1

Official Python SDK for the Scrubbe Operational Intelligence Platform

scrubbe-sdk — Python

Official async Python SDK for the Scrubbe Operational Intelligence Platform. Requires Python ≥ 3.10 and httpx.

Installation

pip install scrubbe-sdk

Quick start

import asyncio
from scrubbe import Scrubbe

async def main():
    async with Scrubbe(api_key="sk-...") as client:
        # Create an incident
        incident = await client.incident.create(
            title="Payment gateway degraded",
            priority="P1",
            service="payment-api",
        )
        print(incident["incident_id"])  # SI-000042

        # List all open incidents (lazy pagination)
        async for inc in client.incident.list(state="INVESTIGATING"):
            print(inc["title"])

        # Stream live events
        async for event in client.incident.subscribe(incident["incident_id"]):
            print(event["type"], event["data"])

asyncio.run(main())

Authentication

# 1. API key
client = Scrubbe(api_key="sk-...")

# 2. OAuth2
client = Scrubbe(client_id="...", client_secret="...")

# 3. Env vars: SCRUBBE_API_KEY or SCRUBBE_CLIENT_ID + SCRUBBE_CLIENT_SECRET
client = Scrubbe()

# 4. Credentials file ~/.scrubbe/credentials
# { "production": { "api_key": "sk-..." } }
client = Scrubbe(profile="production")

Configuration

from scrubbe import Scrubbe
from scrubbe.utils.retry import RetryOptions

client = Scrubbe(
    api_key="...",
    base_url="https://api.scrubbe.com",
    connect_timeout_ms=5_000,
    read_timeout_ms=30_000,
    retry=RetryOptions(max_attempts=3, base_delay_ms=500, max_delay_ms=30_000),
)

Error handling

from scrubbe import (
    GovernanceApprovalRequiredError,
    RateLimitedError,
    UnauthenticatedError,
)

try:
    await client.playbook.run("PB-0001", incident_id="SI-000042")
except GovernanceApprovalRequiredError as e:
    print("Pending approval:", e.approval_id)
except RateLimitedError as e:
    print(f"Retry after {e.retry_after}s")
except UnauthenticatedError:
    print("Check your API key")

Development

pip install -e ".[dev]"
ruff check src/ tests/          # lint
ruff format --check src/ tests/ # format check
mypy src/scrubbe                 # type check
pytest                           # tests + coverage