starting point for django

Author: raphaeltm

samples/django-channels-redis/app/.dockerignore

@@ -1,3 +1,24 @@
-#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed.
-node_modules
-npm-debug.log
+# Ignore development files and directories
+*.pyc
+*.pyo
+*.pyd
+__pycache__/
+.env
+
+# Ignore static files
+/static/
+/media/
+
+# Ignore database files
+/db.sqlite3
+
+# Ignore log files
+/logs/
+
+# Ignore Docker-related files
+Dockerfile
+docker-compose.yml
+
+# Ignore any other unnecessary files or directories
+node_modules/
+*.log

samples/django-channels-redis/app/.gitignore

@@ -1,2 +1,58 @@
-#REMOVE_ME_AFTER_EDITING - This Dockerignore is for a basic node app. Modify as needed.
-node_modules
+# Ignore compiled Python files
+*.pyc
+__pycache__/
+
+# Ignore the virtual environment
+venv/
+env/
+
+# Ignore the Django secret key
+*.secret_key
+
+# Ignore database files
+*.db
+*.sqlite3
+
+# Ignore static files
+staticfiles/
+
+# Ignore media files
+media/
+
+# Ignore log files
+*.log
+
+# Ignore IDE and editor files
+.vscode/
+.idea/
+*.code-workspace
+
+# Ignore local development settings
+local_settings.py
+
+# Ignore deployment files
+deploy/
+
+# Ignore sensitive information
+*.env
+*.env.*
+*.key
+
+# Ignore compiled JavaScript files
+*.js
+
+# Ignore compiled CSS files
+*.css
+
+# Ignore compiled HTML files
+*.html
+
+# Ignore compiled binary files
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Ignore package manager files
+node_modules/
+yarn-error.log

samples/django-channels-redis/app/Dockerfile

@@ -1,5 +1,5 @@
 # Use an official Python runtime as a parent image
-FROM python:3.10.4-slim-buster
+FROM python:3.10.4-slim-buster AS builder
 
 # Set environment variables
 ENV PYTHONDONTWRITEBYTECODE 1
@@ -18,5 +18,26 @@ COPY . /code/
 # Collect static files
 RUN python manage.py collectstatic --noinput
 
+
+# Use a smaller base image for the final stage
+FROM python:3.10.4-slim-buster
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Set work directory
+WORKDIR /code
+
+# Copy the dependencies from the builder stage
+COPY --from=builder /usr/local/lib/python3.10/site-packages /usr/local/lib/python3.10/site-packages
+COPY --from=builder /code /code
+
+# Create a non-root user
+RUN adduser --disabled-password --gecos '' django
+
+# Set the user to the non-root user
+USER django
+
 # Start server
-CMD python manage.py migrate && gunicorn defang_sample.wsgi:application --bind 0.0.0.0:8000
+CMD ["sh", "-c", "python manage.py migrate && gunicorn defang_sample.wsgi:application --bind 0.0.0.0:8000"]

samples/django-channels-redis/app/django_defang/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_defang project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_defang.settings")
+
+application = get_asgi_application()

samples/django-channels-redis/app/django_defang/asgi.py

@@ -0,0 +1,142 @@
+"""
+Django settings for django_defang project.
+
+Generated by 'django-admin startproject' using Django 5.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.1/ref/settings/
+"""
+
+import os
+from pathlib import Path
+import dj_database_url
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-c!3+-wtsf@&6+p-z88$fyqr!zrnd@uvi=hi&u00n+ku9&_04rk"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+if DEBUG:
+    ALLOWED_HOSTS = ["*"]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "django_defang.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "django_defang.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
+
+DATABASES = {
+    # default is a postrgres database load from environment variable POSTGRES_URL
+    "default": dj_database_url.config(
+        default=os.environ.get('POSTGRES_URL')
+    )
+}
+
+# Password validation
+# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+STATIC_ROOT = BASE_DIR / "staticfiles"
+
+STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+CSRF_TRUSTED_ORIGINS = [
+    'https://*.prod1.defang.dev'
+]
+
+if DEBUG:
+    CSRF_TRUSTED_ORIGINS = [
+        'http://localhost:8000',
+    ]

samples/django-channels-redis/app/django_defang/settings.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for django_defang project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]

samples/django-channels-redis/app/django_defang/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_defang project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_defang.settings")
+
+application = get_wsgi_application()

samples/django-channels-redis/app/django_defang/wsgi.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_defang.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

samples/django-channels-redis/app/manage.py

@@ -0,0 +1,11 @@
+asgiref==3.8.1
+dj-database-url==2.2.0
+Django==5.1
+gitdb==4.0.11
+GitPython==3.1.41
+setuptools==69.0.3
+smmap==5.0.1
+sqlparse==0.5.1
+typing_extensions==4.12.2
+wheel==0.44.0
+whitenoise==6.7.0