page:blueprints:developer tools:client portal:django

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).

Representative Queries

• Developer tools: client portal using Django
• Where can I host Developer tools: Client portal built with Django?
• I need a genuinely specialized client portal workflow covering organization access, versioned technical docs and build artifacts.

Workflow Steps

1. Model the developer tools domain
   Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, document_access. Customer organizations live 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.
7. Verify
   Run the pattern self-test(s) from the example (/p/private-document-library) and your own acceptance checks for the developer tools workflow.

Prerequisites

• A Django project (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template)
• A PostgreSQL driver reading DATABASE_URL (auto-provisioned when omitted)
• Bucket credentials from ample bucket create passed as encrypted S3_* environment variables
• A review of which developer tools data classes may be handled at all; this blueprint models public information only.

Cost Estimate

• Monthly Amount: $10.00 (USD)
  • Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.
  • Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.
  • Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.

Limitations

• The technical basis verified with the pattern fixture; the developer tools schema and workflow are an original design for this blueprint and were not executed as a separate application.
• API keys and usage logs are secrets or personal data; keep them out of documentation workflows.
• Verified on the python-3.12 template at s-1vcpu-1gb; region, request-duration limits and other sizes are unknown or unverified.

Evidence Summary

• Kind: canary_run
  Summary of deployed on Ample and checks passed. Observed at 2026-09-20.

Next Actions

• Browse the catalog index
  • ActionId: browse-catalog
  • Method: GET
  • RelativePath: /v1/catalog
• Prepare a side-effect-free deployment plan for an authorized project
  • ActionId: plan:page:blueprints:developer-tools:client-portal:django
  • Method: POST
  • RelativePath: /v1/catalog/plan

For detailed guidance on each section, refer to the respective documentation or blueprint.