Python 3.6+ Web Application

Flask web app that runs on Python 3.6 now, with a clear upgrade path for later.

Quick Start

# Clone and run
git clone git@github.itap.purdue.edu:wbbaker/python-36-template.git
cd python-36-template
./docker-quickstart.sh

Visit http://localhost:5000

Daily Development

make up        # Start everything  
make logs      # View logs
make shell     # Container shell
make test      # Run tests
make down      # Stop everything

Project Structure

core/               # Your code goes here
├── models.py       # Database models
├── views.py        # API endpoints
└── services.py     # Business logic

requirements/       # Dependencies by Python version
├── py36.txt        # Current (Python 3.6)
├── py38.txt        # Future (Python 3.8+) 
└── modern.txt      # Future (Python 3.11+)

API Endpoints

Method	Endpoint	Description
GET	`/api/users`	List users
POST	`/api/users`	Create user (needs: username, email)
GET	`/api/users/{id}`	Get user
PUT	`/api/users/{id}`	Update user
DELETE	`/api/users/{id}`	Delete user
GET	`/api/posts`	List posts
POST	`/api/posts`	Create post (needs: title, user_id)
GET	`/health`	Health check

Adding Features

Database model → Edit core/models.py
API endpoint → Edit core/views.py
Business logic → Edit core/services.py

Update database → Run:

docker compose exec web flask db migrate -m "description"
docker compose exec web flask db upgrade

When Python Gets Upgraded

Check UPGRADE_PLAN.md for what to update
Switch requirements in Dockerfile to py38.txt or modern.txt
Run pyupgrade --py38-plus **/*.py to modernize syntax
Remove compat/ folder
Test everything

Troubleshooting

Port in use?

docker compose down
# Or edit port in compose.yml

Database issues?

docker compose down -v
make up && make db-init

Need logs?

make logs

Running Without Docker

Not recommended, but if needed...

python3.6 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
python init_db.py
python app.py

Production

docker compose -f compose.prod.yml up -d

See compose.prod.yml for environment variables needed.

More Info

UPGRADE_PLAN.md - Python upgrade details
Makefile - All available commands

License

MIT-0 (No Attribution) - Use freely

License

wbbaker/python-36-template

About

Resources

License

Stars

Watchers

Forks

Releases

Languages