Merge pull request #22 from Kandeel4411/docker-multistage-cache

Added Django docker multistage cache example project

Author: thisismydesign

Diff for: README.md

@@ -15,6 +15,7 @@ Each project
 ### Docker
 - [Docker build cache](docker-build-cache)
 - [`docker-compose` build cache](docker-compose-build-cache)
+- [Docker multistage cache](docker-multistage-cache)
 
 ### Ruby
 - [Inline RSpec](inline-rspec)

Diff for: docker-multistage-cache/.dockerignore

@@ -0,0 +1,7 @@
+venv
+db.sqlite3
+
+*.egg-info
+*.egg/
+**/__pycache__
+**/*.pyc

Diff for: docker-multistage-cache/Dockerfile

@@ -0,0 +1,33 @@
+FROM python:3.6-slim-stretch as base
+
+ENV PIP_DISABLE_PIP_VERSION_CHECK on
+# Keeps Python from generating .pyc files in the container
+ENV PYTHONDONTWRITEBYTECODE 1
+# Turns off buffering for easier container logging
+ENV PYTHONUNBUFFERED 1
+
+
+FROM base as dependencies
+
+RUN python -m venv /opt/venv
+# Make sure we use the virtualenv:
+ENV PATH="/opt/venv/bin:$PATH"
+
+COPY .requirements.txt ./
+
+RUN pip install -U pip
+RUN pip install -r requirements.txt
+
+
+FROM base as final
+
+# copy installed deps from dependencies image
+COPY --from=dependencies /opt/venv /opt/venv
+# Make sure we use the virtualenv:
+ENV PATH="/opt/venv/bin:$PATH"
+
+EXPOSE 8000
+WORKDIR /app
+COPY . /app/
+
+CMD ["python", "manage.py", "runserver"]

Diff for: docker-multistage-cache/README.md

@@ -0,0 +1,21 @@
+# Docker Multistage Cache Example
+
+This is an example Django project to illustrate the usage of building intermediate stages and leveraging their built image for caching.
+
+## Prerequisites
+
+- Docker installed.
+
+## Usage
+
+- Build the intermediate dependency stages into separate images with `--target` being the stage's name and a `-t` tag that you could later identify it with. I.e:
+
+  ```bash
+  docker build --target=dependencies -t django_example:dep .
+  ```
+
+- Build the final image use `--cache-from` listing the intermediate image. I.e:
+
+  ```bash
+  docker build --cache-from django_example:dev -t django_example:final .
+  ```

Diff for: docker-multistage-cache/django_example/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_example 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/3.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_example.settings')
+
+application = get_asgi_application()

Diff for: docker-multistage-cache/django_example/asgi.py

@@ -0,0 +1,120 @@
+"""
+Django settings for django_example project.
+
+Generated by 'django-admin startproject' using Django 3.1.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# 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/3.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '1=#mb3lb%++$v=w(zn(6vh8&c7s7f!+b#)iv2e$c*y@l%7bz-3'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+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',
+    '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_example.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_example.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.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/3.1/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.1/howto/static-files/
+
+STATIC_URL = '/static/'

Diff for: docker-multistage-cache/django_example/settings.py

@@ -0,0 +1,21 @@
+"""django_example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.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),
+]

Diff for: docker-multistage-cache/django_example/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_example 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/3.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_example.settings')
+
+application = get_wsgi_application()

Diff for: docker-multistage-cache/django_example/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_example.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()

Diff for: docker-multistage-cache/manage.py

@@ -0,0 +1,4 @@
+asgiref==3.2.10
+Django==3.1.1
+pytz==2020.1
+sqlparse==0.3.1