Go to file
Sean McElwain f5a46d712e Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
app Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
archive Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
calculations Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
content Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
diagnostics Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
exports Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
inputs Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
logs Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
outputs Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
scripts Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
settings Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
static Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
tests Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
.gitignore Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00
README.md Initialize doc-generator scaffold 2026-06-09 21:08:31 -05:00

README.md

doc-generator

Python-based document and report generator.

This project is intended to combine the form-driven document generation workflow of word-doc-generator with a cleaner Python backend structure similar to document-processor.

Planned Structure

  • app/ - Python web application entrypoint and backend logic
  • content/ - reusable templates, report definitions, shared text, and configuration
  • calculations/ - calculation modules used by reports
  • inputs/ - source files and uploaded data for generation runs
  • outputs/ - intermediate generated files
  • exports/ - final downloadable reports/documents
  • archive/ - archived generation runs or prior outputs
  • diagnostics/ - troubleshooting and processing diagnostics
  • settings/ - app settings and environment-independent configuration
  • static/ - frontend assets
  • scripts/ - helper scripts
  • tests/ - automated tests