Perfect Project Starter for Python (Django)

Setup and run

01 - Dependencies

Install Docker (and docker-compose)

• (dev) Docker Desktop
  • (windows) should use WSL2 engine
• (prod)

02 - IDE setup

VsCode - Step 1

• update .vscode/*.json files
  • *.local.json are uncommitted, while *.shared.json are committed
  • The local and shared version will be automatically merged by the plugin below
• Install WorkSpace Config Plus
  • Note: it doesn't work in devconatiners yet

VsCode - Step 2 w/ Dev Container (v1.74.3) (Recommended)

This option will automaitcally include all development dependencies, extension recomendations, debug and run configs. If you don't want to use a dev container skip to the "Other IDEs" section.

Run:

cp -n .devcontainer/setup-container.example.sh .devcontainer/setup-container.sh
cp -n .devcontainer/inputrc.example .devcontainer/inputrc
cp -n .devcontainer/bash.example.bashrc .devcontainer/bash.bashrc

Edit the non-example files to customize your dev container environment.

• Note: After you have started the dev container (in a few steps) you will need to refresh the dev container any time you update files in .devcontainer/*
  • ctrl + shift + P > Dev Containers: Rebuild Container for a completely fresh re-application

Install the Dev Containers Extension(v0.266.1)

• It should ask if you want to "Reopen in Container", say yes. (Otherwise, click on the bottom left corner (green), Reopen in Container (Dev Container))

Other IDEs

With this option you are in charge of installing and configuring all dependancies/extensions correctly

• Register commit hooks git config core.hooksPath git_hooks
• Install Node 18
• Install extensions:
  • EditorConfig (recommended) [vscode]
  • Docker (optional) [vscode]

03 - Setup Project

Run initial setup script (safe to rerun)

• (dev) ./setup-dev.sh
• (prod) ./setup-prod.sh

Django / Python:

Fill out the following files as appropriate:

• /proj_django/zz_config_zzz/settings_local.py
  • Set DEBUG=True
  • Other settings as desired
• /docker/postgres.env

Notes:

• Put your python code in proj_django
• You must have at least an empty requirements.txt file
  • NOTE: If you don't have any files in this folder docker will mess up the permissions on this folder for some reason -.-)
• If requirements.txt changes you should rebuild the image
  • docker-compose build python
• When running, visit http://localhost:8080/
  • Don't forget to disable browser caching in chrome devtools when developing.

If you need to interactively initialize your python code, run

./backend-start.sh i

Then you can run commands like these (this is an example for initializing a django/postgres project):

python -m pip install Django==4.1.7
django-admin startproject zzz_config_zzz .
# Next line for postgresql
python -m pip install psycopg2==2.9.5
python -m pip freeze > requirements.txt
# Add an app
python manage.py startapp myapp
python manage.py makemigrations myapp
python manage.py migrate
# Create admin panel super user
python manage.py createsuperuser
# finsihed
exit

04 Run Project Portion

Each project portion has it's run-*.sh <option> file. Some projects have unique options (eg. django has mm for makemigrations), see the file for all available options and more details.

Common options are:

• (default) - run program (debugging enabled)
• w - run program and wait debugger to attach
• p - run production program
• t - test (debugging enabled)
• tw - test and wait debugger to attach
• s - autofix some styles and style check
• st - style check and test
• i - interactive (get into the projgram's docker container)