commit f5a46d712e217514845d20eb6e9efc2678a57ae5 Author: McElwain Date: Tue Jun 9 21:08:31 2026 -0500 Initialize doc-generator scaffold diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f11a0d2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,35 @@ +.venv/ +venv/ +__pycache__/ +*.pyc + +.env +.env.* + +*.log +.DS_Store +Thumbs.db +~$* +*.tmp +node_modules/ + +logs/* +!logs/.gitkeep + +outputs/* +!outputs/.gitkeep + +exports/* +!exports/.gitkeep + +inputs/uploads/* +!inputs/uploads/.gitkeep + +archive/* +!archive/.gitkeep +!archive/current/ +archive/current/* +!archive/current/.gitkeep + +diagnostics/* +!diagnostics/.gitkeep diff --git a/README.md b/README.md new file mode 100644 index 0000000..c70c398 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# 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 diff --git a/app/.gitkeep b/app/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/main.py b/app/main.py new file mode 100644 index 0000000..e69de29 diff --git a/archive/.gitkeep b/archive/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/archive/current/.gitkeep b/archive/current/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/calculations/.gitkeep b/calculations/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/calculations/__init__.py b/calculations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/content/.gitkeep b/content/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/content/report_types/.gitkeep b/content/report_types/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/content/shared/.gitkeep b/content/shared/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/content/templates/.gitkeep b/content/templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/diagnostics/.gitkeep b/diagnostics/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/exports/.gitkeep b/exports/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/inputs/.gitkeep b/inputs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/inputs/examples/.gitkeep b/inputs/examples/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/inputs/uploads/.gitkeep b/inputs/uploads/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/logs/.gitkeep b/logs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/outputs/.gitkeep b/outputs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/scripts/.gitkeep b/scripts/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/settings/.gitkeep b/settings/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/static/.gitkeep b/static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/.gitkeep b/tests/.gitkeep new file mode 100644 index 0000000..e69de29