Merge branch 'main' into davidfischer/switch-to-tailwind

Author: davidfischer

.env/local.sample

@@ -1,8 +1,35 @@
 # This is a sample of environment variables which are used only to run Docker locally.
 # These are never used in production.
 
+# Django
+# ------------------------------------------------------------------------------
+# Run Django in production mode (DEBUG=False)
+DJANGO_SETTINGS_MODULE=config.settings.prod
+
 # Use a strong secret in production
 SECRET_KEY="this-is-a-bad-secret"
 
-# In production, we use postgres but for testing a deployment, using SQLite is fine
-DATABASE_URL="sqlite:///db.sqlite3"
+
+# PostgreSQL
+# ------------------------------------------------------------------------------
+# This must match .env/postgres
+DATABASE_URL=pgsql://localuser:localpass@postgres:5432/sandiegopython
+
+
+# Redis
+# ------------------------------------------------------------------------------
+REDIS_URL=redis://redis:6379/0
+
+
+# S3/R2 Media Storage
+# ------------------------------------------------------------------------------
+# If not empty, S3/R2 will be used for media storage
+AWS_S3_ACCESS_KEY_ID=
+AWS_S3_SECRET_ACCESS_KEY=
+AWS_STORAGE_BUCKET_NAME=
+# If using a custom domain for media storage, set the MEDIA_URL
+#  and AWS_S3_CUSTOM_DOMAIN
+AWS_S3_CUSTOM_DOMAIN=
+MEDIA_URL=/media/
+# The endpoint URL is necessary for Cloudflare R2
+AWS_S3_ENDPOINT_URL=

.env/postgres

@@ -0,0 +1,7 @@
+# PostgreSQL
+# ------------------------------------------------------------------------------
+POSTGRES_HOST=postgres
+POSTGRES_PORT=5432
+POSTGRES_DB=sandiegopython
+POSTGRES_USER=localuser
+POSTGRES_PASSWORD=localpass

.gitignore

@@ -131,7 +131,7 @@ dmypy.json
 ############################################
 /node_modules/
 /staticfiles/
-/pythonsd/media/
+/media/
 /pythonsd/static/css/
 /GIT_COMMIT
 /BUILD_DATE

Dockerfile

@@ -20,25 +20,27 @@ RUN apt-get install -y --no-install-recommends \
     make \
     build-essential \
     g++ \
+    postgresql-client \
     git
 
 RUN mkdir -p /code
 
 WORKDIR /code
 
-COPY . /code/
+# Requirements are installed here to ensure they will be cached.
+# https://docs.docker.com/build/cache/#use-the-dedicated-run-cache
+COPY ./requirements /requirements
+RUN pip install --upgrade pip
+RUN --mount=type=cache,target=/root/.cache/pip pip install -r /requirements/deployment.txt
+RUN --mount=type=cache,target=/root/.cache/pip pip install -r /requirements/local.txt
 
-# Cache dependencies when building which should result in faster docker builds
-RUN --mount=type=cache,target=/root/.cache/pip set -ex && \
-    pip install --upgrade --no-cache-dir pip && \
-    pip install -r /code/requirements.txt && \
-    pip install -r /code/requirements/local.txt
+COPY . /code/
 
 # Build JS/static assets
-RUN npm install
+RUN --mount=type=cache,target=/root/.npm npm install
 RUN npm run build
 
-RUN python manage.py collectstatic --noinput
+RUN python manage.py collectstatic --noinput --clear
 
 # Run the container unprivileged
 RUN addgroup www && useradd -g www www
@@ -52,4 +54,4 @@ RUN date -u +'%Y-%m-%dT%H:%M:%SZ' > BUILD_DATE
 
 EXPOSE 8000
 
-CMD ["gunicorn", "--timeout", "15", "--bind", ":8000", "--workers", "2", "--max-requests", "10000", "--max-requests-jitter", "100", "config.wsgi"]
+CMD ["gunicorn", "--timeout", "15", "--bind", ":8000", "--workers", "2", "--max-requests", "10000", "--max-requests-jitter", "100", "--log-file", "-", "--access-logfile", "-", "config.wsgi"]

Makefile

@@ -1,10 +1,17 @@
-.PHONY: help test clean deploy
+.PHONY: help test clean dockerbuild dockerserve dockershell deploy
+
+
+DOCKER_CONFIG=compose.yaml
 
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  test           Run the full test suite"
 	@echo "  clean          Delete assets processed by webpack"
+	@echo "  dockerbuild    Build the Docker compose dev environment"
+	@echo "  dockerserve    Run the Docker containers for the site"
+	@echo "                 (starts a webserver on http://localhost:8000)"
+	@echo "  dockershell    Connect to a bash shell on the Django Docker container"
 	@echo "  deploy         Deploy the app to fly.io"
 
 
@@ -14,6 +21,21 @@ test:
 clean:
 	rm -rf assets/dist/*
 
+# Build the local multi-container application
+# This command can take a while the first time
+dockerbuild:
+	docker compose -f $(DOCKER_CONFIG) build
+
+# You should run "dockerbuild" at least once before running this
+# It isn't a dependency because running "dockerbuild" can take some time
+dockerserve:
+	docker compose -f $(DOCKER_CONFIG) up
+
+# Use this command to inspect the container, run management commands,
+# or run anything else on the Django container
+dockershell:
+	docker compose -f $(DOCKER_CONFIG) run --rm django /bin/bash
+
 # Build and deploy the production container
 deploy:
 	flyctl deploy

README.md

@@ -42,13 +42,19 @@ you can build the container and run it locally:
 cp .env/local.sample .env/local
 
 # Build the docker image for sandiegopython.org
-docker buildx build -t sandiegopython.org .
-
-# Start a development server on http://localhost:8000
-docker run --env-file=".env/local" --publish=8000:8000 sandiegopython.org
-
-# You can start a shell to the container with the following:
-docker run --env-file=".env/local" -it sandiegopython.org /bin/bash
+# Use Docker compose to have Redis and PostgreSQL just like in production
+# Note: Docker is used in production but Docker compose is just for development
+make dockerbuild
+
+# Start a development web server on http://localhost:8000
+# Use ctrl+C to stop
+make dockerserve
+
+# While the server is running,
+# you can start a bash shell to the container with the following:
+# Once you have a bash shell, you can run migrations,
+# manually connect to the local Postgres database or anything else
+make dockershell
 ```
 
 

compose.yaml

@@ -0,0 +1,40 @@
+# Docker Compose Local Development Setup
+#
+# This starts a local multi-container development environment
+# with Postgres, Redis, and Django.
+# The configuration comes from .env/local and .env/postgres
+#
+# To run:
+#   $ make dockerbuild
+#   $ make dockerserve
+
+volumes:
+  local_postgres_data: {}
+
+services:
+  django:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    image: sandiegopython_local_django
+    depends_on:
+      - postgres
+    env_file:
+      - ./.env/local
+      - ./.env/postgres
+    ports:
+      - "${SANDIEGOPYTHON_DJANGO_PORT:-8000}:8000"
+    # Allow us to run `docker attach` and get
+    # control on STDIN and be able to debug our code with interactive pdb
+    stdin_open: true
+    tty: true
+
+  postgres:
+    image: postgres:15.2
+    volumes:
+      - local_postgres_data:/var/lib/postgresql/data
+    env_file:
+      - ./.env/postgres
+
+  redis:
+    image: redis:5.0

config/settings/base.py

@@ -2,10 +2,10 @@
 Django settings for pythonsd project.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/3.2/topics/settings/
+https://docs.djangoproject.com/en/4.2/topics/settings/
 
 For the full list of settings and their values, see
-https://docs.djangoproject.com/en/3.2/ref/settings/
+https://docs.djangoproject.com/en/4.2/ref/settings/
 """
 
 import json
@@ -20,7 +20,7 @@
 
 
 # Quick-start development settings - unsuitable for production
-# https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+# https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
 # SECURITY WARNING: don't run with debug turned on in production!
@@ -82,47 +82,52 @@
 
 
 # Database
-# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
 # --------------------------------------------------------------------------
 DATABASES = {"default": dj_database_url.config(default="sqlite:///db.sqlite3")}
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
 
 # Internationalization
-# https://docs.djangoproject.com/en/3.2/topics/i18n/
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
 # --------------------------------------------------------------------------
 LANGUAGE_CODE = "en-us"
 
 TIME_ZONE = "America/Los_Angeles"
 
 USE_I18N = True
 
-USE_L10N = True
-
 USE_TZ = True
 
 
 # Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/3.2/howto/static-files/
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+# https://docs.djangoproject.com/en/4.2/ref/settings/#std-setting-STORAGES
 # --------------------------------------------------------------------------
 STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
 STATIC_URL = "/static-files/"
-
-# Due to a bug relating to the manifest not being generated before the tests run
-# We can't use CompressedManifestStaticFilesStorage (yet)
-STATICFILES_STORAGE = "whitenoise.storage.CompressedStaticFilesStorage"
 STATICFILES_DIRS = [
     os.path.join(BASE_DIR, "assets", "dist"),
     os.path.join(BASE_DIR, "pythonsd", "static"),
     # Only available after running `npm install`
     os.path.join(BASE_DIR, "node_modules/htmx.org/dist"),
 ]
 
-MEDIA_URL = "/media/"
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
+
+MEDIA_URL = os.environ.get("MEDIA_URL", default="/media/")
 MEDIA_ROOT = os.path.join(BASE_DIR, "media")
 
 
 # Email
-# https://docs.djangoproject.com/en/3.2/topics/email/
+# https://docs.djangoproject.com/en/4.2/topics/email/
 # --------------------------------------------------------------------------
 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 DEFAULT_FROM_EMAIL = "[email protected]"
@@ -133,8 +138,8 @@
 # A sample logging configuration. The only tangible logging
 # performed by this configuration is to send an email to
 # the site admins on every HTTP 500 error when DEBUG=False.
-# http://docs.djangoproject.com/en/3.2/topics/logging
-# https://docs.djangoproject.com/en/3.2/ref/settings/#logging
+# http://docs.djangoproject.com/en/4.2/topics/logging
+# https://docs.djangoproject.com/en/4.2/ref/settings/#logging
 # --------------------------------------------------------------------------
 LOGGING = {
     "version": 1,

config/settings/prod.py

@@ -12,7 +12,7 @@
 from .base import *  # noqa
 
 
-# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
 DEBUG = False
 SECRET_KEY = os.environ["SECRET_KEY"]
@@ -34,16 +34,32 @@
 ADMIN_URL = os.environ.get("ADMIN_URL", "admin")
 
 
+# Django-storages
+# https://django-storages.readthedocs.io
+# --------------------------------------------------------------------------
+# Optionally store media files in S3/R2/etc.
+AWS_S3_ACCESS_KEY_ID = os.environ.get("AWS_S3_ACCESS_KEY_ID")
+AWS_S3_SECRET_ACCESS_KEY = os.environ.get("AWS_S3_SECRET_ACCESS_KEY")
+AWS_STORAGE_BUCKET_NAME = os.environ.get("AWS_STORAGE_BUCKET_NAME")
+# When using media storage with a custom domain
+# set this and set MEDIA_URL
+AWS_S3_CUSTOM_DOMAIN = os.environ.get("AWS_S3_CUSTOM_DOMAIN")
+# The endpoint URL is necessary for Cloudflare R2
+AWS_S3_ENDPOINT_URL = os.environ.get("AWS_S3_ENDPOINT_URL", default=None)
+if AWS_S3_ACCESS_KEY_ID and AWS_S3_SECRET_ACCESS_KEY and AWS_STORAGE_BUCKET_NAME:
+    STORAGES["default"]["BACKEND"] = "storages.backends.s3.S3Storage"
+
+
 # Database
-# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
 # --------------------------------------------------------------------------
 DATABASES = {"default": dj_database_url.config()}
 DATABASES["default"]["ATOMIC_REQUESTS"] = True
 DATABASES["default"]["CONN_MAX_AGE"] = 600
 
 
 # Caching
-# https://docs.djangoproject.com/en/3.2/ref/settings/#caches
+# https://docs.djangoproject.com/en/4.2/ref/settings/#caches
 # http://niwinz.github.io/django-redis/
 # --------------------------------------------------------------------------
 if "REDIS_URL" in os.environ:
@@ -60,7 +76,7 @@
 
 
 # Security
-# https://docs.djangoproject.com/en/3.2/topics/security/
+# https://docs.djangoproject.com/en/4.2/topics/security/
 # --------------------------------------------------------------------------
 if "SECURE_SSL_HOST" in os.environ:
     SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
@@ -83,14 +99,14 @@
 
 
 # Sessions
-# https://docs.djangoproject.com/en/3.2/topics/http/sessions/
+# https://docs.djangoproject.com/en/4.2/topics/http/sessions/
 # Don't put sessions in the database
 
 SESSION_ENGINE = "django.contrib.sessions.backends.signed_cookies"
 
 
 # Email
-# https://docs.djangoproject.com/en/3.2/topics/email/
+# https://docs.djangoproject.com/en/4.2/topics/email/
 # https://anymail.readthedocs.io/en/stable/
 # --------------------------------------------------------------------------
 if "SENDGRID_API_KEY" in os.environ:
@@ -100,7 +116,7 @@
 
 
 # Logging
-# http://docs.djangoproject.com/en/3.2/topics/logging
+# http://docs.djangoproject.com/en/4.2/topics/logging
 # --------------------------------------------------------------------------
 LOGGING["loggers"][""]["level"] = "INFO"
 LOGGING["loggers"]["pythonsd"]["level"] = "INFO"