# Bookkeeping practices: client portal using Django

A client portal blueprint for bookkeeping practices built with Django on Ample. Domain schema: 
- **client_entities** (legal_name, entity_type, accounting_software, period_cadence): clients and their bookkeeping cadence; 
- **engagements** (client_entity_id, period_start, period_end, close_status): monthly or quarterly close engagements; 
- **document_requests** (engagement_id, category, due_at, status, uploaded_object_key): receipts, statements and payroll summaries requested; 
- **close_checklists** (engagement_id, item, done_at): close tasks per period; 
- **document_access** (document_id, principal_reference, role, granted_at): who may read which document.

Public information: service packages and cadence, onboarding checklist, contact details. Kept out of scope until handling is reviewed: bank statements and receipts, payroll data, login credentials for accounting software. Never store client accounting-software credentials in these flows; financial records are sensitive. 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).

## What it runs on

- **[Computeverified](/content/discover/primitive/compute/index.html)**  
Apps run in isolated x86_64 Firecracker microVMs; sizes are the priced VM sizes.
- **[Postgresverified](/content/discover/primitive/postgres/index.html)**  
Managed PostgreSQL 16 with pgvector runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.
- **[S3-compatible object storageverified](/content/discover/primitive/s3-compatible-object-storage/index.html)**  
Buckets speak the S3 API with SigV4 credentials Ample Computer issues; `ample bucket upload-url` returns a presigned upload URL. PutObject and GetObject are checked by canary.

## You need

- 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 bookkeeping practices data classes may be handled at all; this blueprint models public information only

## Exact tested configuration

```bash
install python3 -m pip install --target .ample/python -r requirements.txt
runtime python
sizes-1vcpu-1gb
start PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py
template python-3.12
```

## Steps

1. **Model the bookkeeping practices domain.** Create the tables client_entities, engagements, document_requests, close_checklists, document_access. Clients and their bookkeeping cadence lives in client_entities; keep the sensitive classes (bank statements and receipts, payroll data, login credentials for accounting software) 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.

```bash
$ 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=...
```

7. **Verify.** Run the pattern self-test(s) from the example (/p/private-document-library) and your own acceptance checks for the bookkeeping practices workflow.

```bash
$ ample logs <deployment_id> --kind build
```

## How it was checked

✓ app responds on its public URL· http get/ → “ample canary django patterns”  
✓ private-document-library self-test from the example· http get/p/private-document-library → “see the pattern fixture checks”

## Evidence

1. November 6, 2026 · canary run  
Django pattern fixture deployed on Ample (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template); the private document library checks passed: 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). The blueprint's Bookkeeping practices schema and workflow below build on that verified basis.

## Tested examples

- **Django pattern fixture.** Verified private document library basis for this blueprint.

## What it doesn’t cover

- The technical basis (private document library on Django) was verified with the pattern fixture; the bookkeeping practices schema and workflow are an original design for this blueprint, built on that basis.
- Never store client accounting-software credentials in these flows; financial records are sensitive.
- Verified on the python-3.12 template at s-1vcpu-1gb.
- Managed PostgreSQL 16 with pgvector.
- Buckets speak the standard S3 API (PutObject and GetObject with path-style addressing are checked by the fixture); `ample bucket upload-url` returns presigned upload URLs.
