From f5a46d712e217514845d20eb6e9efc2678a57ae5 Mon Sep 17 00:00:00 2001 From: McElwain Date: Tue, 9 Jun 2026 21:08:31 -0500 Subject: [PATCH] Initialize doc-generator scaffold --- .gitignore | 35 +++++++++++++++++++++++++++++++++++ README.md | 20 ++++++++++++++++++++ app/.gitkeep | 0 app/__init__.py | 0 app/main.py | 0 archive/.gitkeep | 0 archive/current/.gitkeep | 0 calculations/.gitkeep | 0 calculations/__init__.py | 0 content/.gitkeep | 0 content/report_types/.gitkeep | 0 content/shared/.gitkeep | 0 content/templates/.gitkeep | 0 diagnostics/.gitkeep | 0 exports/.gitkeep | 0 inputs/.gitkeep | 0 inputs/examples/.gitkeep | 0 inputs/uploads/.gitkeep | 0 logs/.gitkeep | 0 outputs/.gitkeep | 0 scripts/.gitkeep | 0 settings/.gitkeep | 0 static/.gitkeep | 0 tests/.gitkeep | 0 24 files changed, 55 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 app/.gitkeep create mode 100644 app/__init__.py create mode 100644 app/main.py create mode 100644 archive/.gitkeep create mode 100644 archive/current/.gitkeep create mode 100644 calculations/.gitkeep create mode 100644 calculations/__init__.py create mode 100644 content/.gitkeep create mode 100644 content/report_types/.gitkeep create mode 100644 content/shared/.gitkeep create mode 100644 content/templates/.gitkeep create mode 100644 diagnostics/.gitkeep create mode 100644 exports/.gitkeep create mode 100644 inputs/.gitkeep create mode 100644 inputs/examples/.gitkeep create mode 100644 inputs/uploads/.gitkeep create mode 100644 logs/.gitkeep create mode 100644 outputs/.gitkeep create mode 100644 scripts/.gitkeep create mode 100644 settings/.gitkeep create mode 100644 static/.gitkeep create mode 100644 tests/.gitkeep 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