- SQLAlchemy ORM with Postgres
- Alembic Database migration
- Application config file
- Logging
- Pytest Unit testing
- Shell scripts for common tasks
| File | Description | |
|---|---|---|
| alembic/ | Alembic migrations and support script | |
| logs/ | Application logs | |
| src/ | Source code for app | |
| app/ | main application | |
| db/ | database and models | |
| util/ | provides various utility functions | |
| main.py | main file to run | |
| utility.py | for performing maintenance tasks/ad-hoc test | |
| tests/ | unit tests for application | |
| alembic.ini | alembic specific settings | |
| config.ini | application config in use | |
| config.ini.example | example of application config | |
| pytest.ini | settings for pytest | |
| requirements.txt | requirements for application | |
| run_pytest.sh | simply run pytest | |
| setup_venv.sh | sets up the virtual environment | |
| upgrade_database.sh | updates the database schema to definitions in models.py |