django.md

Developer tools: client portal using Django

Summary

A client portal blueprint for developer tools built with Django on Ample. Domain schema: customer_workspaces (name, plan, api_key_count): customer organizations; doc_versions (product_version, title, object_key, published_at): versioned reference docs and guides; sdk_releases (language, version, changelog_object_key, released_at): SDK releases and changelogs; customer_assets (workspace_id, title, object_key, visibility): customer-specific artifacts; document_access (document_id, principal_reference, role, granted_at): who may read which document. Public information: versioned API reference and guides, SDK release notes, status page links. Kept out of scope until handling is reviewed: customer API keys and usage logs, private integration details. API keys and usage logs are secrets or personal data; keep them out of documentation workflows. Technical basis verified on Django: a role-to-document access model with negative tests (401 without identity, 403 for the wrong role) and a private-bucket round-trip for the allowed role (private=ok).

Infrastructure requirements

Prerequisites

Exact tested configuration

Steps

  1. Model the developer tools domain. Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, document_access. Customer organizations lives in customer_workspaces; keep the sensitive classes (customer API keys and usage logs, private integration details) out of this schema.
  2. Workflow step 1. Model client entities and engagement periods; every document belongs to one engagement
  3. Workflow step 2. Authorize by client entity and role before any storage access (401 without identity, 403 for the wrong client)
  4. Workflow step 3. Store documents in the private bucket and stream them through the app
  5. Workflow step 4. Deploy and verify the negative authorization tests and an authorized download
  6. Deploy. Run the synchronous deploy once and read the result. Re-running with no change is a no-op.
   ample deploy . --name <app-name> --public --start "python3 run.py" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=...
  1. Verify. Run the pattern self-test(s) from the example (/p/private-document-library) and your own acceptance checks for the developer tools workflow.
   ample logs <deployment_id> --kind build

Tested examples

Success checks

Limitations

Cost estimate

Estimated 10.00 USD per month (size prices from pricing.toml at build revision a1b8c38919e59cd035ebabaced73cf84ece24371).

Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.

Verification evidence

Last verified: 2026-09-20T03:31:44Z

Execution binding

MCP tool ample_deploy (registry mcp:ample_deploy), schema hash 876465fce906da0c observed 2026-09-21T03:19:59.461917+00:00 at revision 49962bcade4f, binding state current, required scopes: servers:write, databases:read, buckets:read.