doc-generator/README.md

21 lines
908 B
Markdown

# 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