CUSTOMIZATION.md

Customizing the template

Required changes

1. Replace the example issuer allowlist in config/ledger.example.yml.
2. Set LEDGER_SEC_USER_AGENT to a monitored organizational contact.
3. Decide whether local DuckDB is sufficient or BigQuery is required.
4. Rename Terraform resources only through variables or locals; do not hard-code personal names.
5. Define retention, data classification, and access policies before storing filing documents or derived text.

Reusing the architecture outside SEC data

The reusable pattern is:

allowlisted entities -> fixture/live client -> raw preservation -> normalization -> dbt contracts -> governed marts

To adapt it:

• implement another client with the same fetch boundary
• replace normalize_companyfacts with domain-specific normalization
• preserve fixture parity
• keep stable raw and normalized contracts
• update dbt models and tests at the same grain

Security rules

Never commit:

• cloud project IDs tied to private environments
• service-account keys
• personal email addresses or phone numbers
• API keys, cookies, tokens, or secrets
• production query results or unredacted logs

Use workload identity for CI and Secret Manager for runtime credentials.