512b7a0f6c
Non-negotiable structural rules that apply to every Claude Code session in
this repo and to every commit, enforced via three defense-in-depth layers:
1. PreToolUse hook in .claude/settings.json blocks any Write/Edit that
would push a file past the 500-line hard cap. Auto-loads for any
Claude session in this repo regardless of who launched it.
2. scripts/githooks/pre-commit (installed via scripts/install-hooks.sh)
enforces the LOC cap, freezes migrations/ unless [migration-approved],
and protects guardrail files unless [guardrail-change] is present.
3. .gitea/workflows/ci.yaml gets loc-budget + guardrail-integrity jobs,
plus mypy --strict on new Python packages, tsc --noEmit on Node
services, and a syft+grype SBOM scan.
Per-language conventions are documented in AGENTS.python.md / AGENTS.go.md /
AGENTS.typescript.md at the repo root — layering (router->service->repo for
Python, hexagonal for Go, colocation for Next.js), tooling baseline, and
explicit "what you may NOT do" lists.
Adds scripts/check-loc.sh (soft 300 / hard 500, reports 205 hard and 161
soft violations in the current codebase) plus .claude/rules/loc-exceptions.txt
(initially empty — the list is designed to shrink over time).
Per-service READMEs for all 10 services + PHASE1_RUNBOOK.md for the
backend-compliance refactor. Skeleton packages (compliance/{domain,
repositories,schemas}) are the landing zone for the clean-arch rewrite that
begins in Phase 1.
CLAUDE.md is prepended with the six non-negotiable rules.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# dsms-gateway
|
|
|
|
Python/FastAPI gateway to the IPFS-backed document archival store. Upload, retrieve, verify, and archive legal documents with content-addressed immutability.
|
|
|
|
**Port:** `8082` (container: `bp-compliance-dsms-gateway`)
|
|
**Stack:** Python 3.11, FastAPI, IPFS (Kubo via `dsms-node`).
|
|
|
|
## Architecture (target — Phase 4)
|
|
|
|
`main.py` (467 LOC) will split into:
|
|
|
|
```
|
|
dsms_gateway/
|
|
├── main.py # FastAPI app factory, <50 LOC
|
|
├── routers/ # /documents, /legal-documents, /verify, /node
|
|
├── ipfs/ # IPFS client wrapper
|
|
├── services/ # Business logic (archive, verify)
|
|
├── schemas/ # Pydantic models
|
|
└── config.py
|
|
```
|
|
|
|
See `../AGENTS.python.md`.
|
|
|
|
## Run locally
|
|
|
|
```bash
|
|
cd dsms-gateway
|
|
pip install -r requirements.txt
|
|
export IPFS_API_URL=http://localhost:5001
|
|
uvicorn main:app --reload --port 8082
|
|
```
|
|
|
|
## Tests
|
|
|
|
```bash
|
|
pytest test_main.py -v
|
|
```
|
|
|
|
Note: the existing test file is larger than the implementation — good coverage already. Phase 4 splits both into matching module pairs.
|
|
|
|
## Public API surface
|
|
|
|
```
|
|
GET /health
|
|
GET /api/v1/documents
|
|
POST /api/v1/documents
|
|
GET /api/v1/documents/{cid}
|
|
GET /api/v1/documents/{cid}/metadata
|
|
DELETE /api/v1/documents/{cid}
|
|
POST /api/v1/legal-documents/archive
|
|
GET /api/v1/verify/{cid}
|
|
GET /api/v1/node/info
|
|
```
|
|
|
|
Every path is a contract — updating requires synchronized updates in consumers.
|