Initialize doc-generator scaffold

This commit is contained in:
Sean McElwain 2026-06-09 21:08:31 -05:00
commit f5a46d712e
24 changed files with 55 additions and 0 deletions

35
.gitignore vendored Normal file
View File

@ -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

20
README.md Normal file
View File

@ -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

0
app/.gitkeep Normal file
View File

0
app/__init__.py Normal file
View File

0
app/main.py Normal file
View File

0
archive/.gitkeep Normal file
View File

0
archive/current/.gitkeep Normal file
View File

0
calculations/.gitkeep Normal file
View File

0
calculations/__init__.py Normal file
View File

0
content/.gitkeep Normal file
View File

View File

0
content/shared/.gitkeep Normal file
View File

View File

0
diagnostics/.gitkeep Normal file
View File

0
exports/.gitkeep Normal file
View File

0
inputs/.gitkeep Normal file
View File

0
inputs/examples/.gitkeep Normal file
View File

0
inputs/uploads/.gitkeep Normal file
View File

0
logs/.gitkeep Normal file
View File

0
outputs/.gitkeep Normal file
View File

0
scripts/.gitkeep Normal file
View File

0
settings/.gitkeep Normal file
View File

0
static/.gitkeep Normal file
View File

0
tests/.gitkeep Normal file
View File