Documentation

SDK reference, platform guides, and integration examples.

For LLMs & AI assistants: Download CLAUDE.md or AGENTS.md and add it to your workspace for full framework context, including the pyscoped[django] integration. Or fetch programmatically: GET /docs/claude.md GET /docs/agents.md

Platform

Management plane — REST API, dashboard, deployment, and architecture.

pyscoped SDK

Framework library — objects, scopes, audit, secrets, and integrations.

Guides

Getting Started
Zero to working in 5 minutes
Architecture
16-layer model, invariants, and design philosophy
Security & Isolation
Isolation model, RLS, rules engine, audit chain
Multi-Tenant Isolation
Postgres RLS and database-per-tenant setup

API Reference

Client & Initialization
ScopedClient, init(), context management
Principals
Identity management — users, teams, services
Objects
Versioned, isolated data objects
Scopes
Tenancy, sharing, membership, projection
Audit Trail
Tamper-evident hash-chained audit queries
Secrets
Encrypted vault with zero-trust access
Storage Backends
SQLite, PostgreSQL, TenantRouter

Integrations

Django
Middleware, DRF, async views, management commands
FastAPI
Middleware, dependencies, WebSocket support
Flask
Extension, app factory, admin blueprint
MCP Server
Model Context Protocol tools and resources

Features

Events & Webhooks
Event bus, webhook delivery, notifications
Scheduling & Jobs
Recurring schedules, job queue, execution
Connectors & Federation
Cross-org sync, policies, state machine
Operations
Migrations, sync agent, monitoring, logging

Reference

Testing
Test utilities, fixtures, assertion helpers
Exceptions
Complete exception hierarchy reference

Layer Deep-Dives

Layer 0: Compliance
Invariant validation across all layers
Layer 1: Registry
Universal construct registration (URNs)
Layer 2: Identity
Principals and ScopedContext
Layer 3: Objects
Versioned, isolation-enforced data
Layer 4: Tenancy
Scopes, membership, projections
Layer 5: Rules
Policy engine with deny-overrides
Layer 6: Audit
Hash-chained immutable trail
Layer 7: Temporal
Rollback and reconstruction
Layer 8: Environments
Ephemeral workspaces
Layer 9: Flow
Stages, pipelines, promotions
Layer 10: Deployments
Graduation to external targets
Layer 11: Secrets
Encrypted vault
Layer 12: Integrations
Sandboxed plugins
Layer 13: Connector
Cross-org federation
Layer 14: Events
Async event bus and webhooks
Layer 15: Notifications
Principal-targeted messages
Layer 16: Scheduling
Recurring schedules and jobs

Programmatic Access

GET

/docs/manifest.json

SDK docs index

GET

/docs/platform/manifest.json

Platform docs index

GET

/docs/raw/{'{path}'}

Raw markdown (SDK)

GET

/docs/claude.md

LLM workspace context

GET

/docs/agents.md

Agent workspace context