First commit

Author: Joe Wass

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.idea
+.pyc
+__pycache__

Dockerfile

@@ -0,0 +1,19 @@
+# Use an official Python runtime as a parent image
+FROM python:3.7
+
+# Set environment varibles
+ENV PYTHONUNBUFFERED 1
+ENV DJANGO_ENV dev
+
+COPY ./requirements.txt /code/requirements.txt
+RUN pip install --upgrade pip
+RUN pip install -r /code/requirements.txt
+RUN pip install gunicorn
+
+COPY . /code/
+WORKDIR /code/
+
+EXPOSE 8000
+
+# default run, can be overridden in docker compose.
+CMD gunicorn demoproject.wsgi:application --bind 0.0.0.0:8000 --workers 3

README.md

@@ -0,0 +1,32 @@
+# Django Demo Project
+
+Quick demo project to show Django.
+
+ - Runs in Docker
+ - Hello World response
+ - Naive JSON response
+ - Django REST API based response.
+ - Swagger schema
+
+
+To run:
+
+    docker-compose build
+
+(Run this again if you change your dependencies or Dockerfile)
+
+
+To run development:
+
+    docker-compose run --service-ports dev
+
+Then visit
+
+
+ - <http://localhost:8000/>
+ - <http://localhost:8000/naive/numbers> - JSON response done naively.
+ - <http://localhost:8000/naive/numbers/28>
+ - <http://localhost:8000/numbers/> - API with properly defined entities.
+ - <http://localhost:8000/numbers/28/ >
+ - <http://localhost:8000/docs/> - Auto generated Docs.
+

demoproject/__init__.py

@@ -0,0 +1,120 @@
+"""
+Django settings for demoproject project.
+
+Generated by 'django-admin startproject' using Django 2.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.2/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '!^)x7f&ng*&8-3q7xrohpdgqr3^t@b%pbk7r$bnb%jub_9jht4'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = [
+"0.0.0.0",
+"localhost"
+]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'rest_framework',
+    'coreapi'
+]
+
+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 = 'demoproject.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 = 'demoproject.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
+
+DATABASES = {
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/2.2/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/2.2/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/2.2/howto/static-files/
+
+STATIC_URL = '/static/'

demoproject/settings.py

@@ -0,0 +1,18 @@
+from django.urls import path
+from django.conf.urls import url, include
+from rest_framework.documentation import include_docs_urls
+
+from . import views
+
+urlpatterns = [
+    path('', views.home, name='home'),
+    
+    # Naive...
+    path('naive/numbers', views.naive_numbers),
+    path('naive/numbers/<int:num_id>', views.naive_number),
+    
+    # Using REST API
+    url(r'^', include(views.numbers_router.urls)),
+    url(r'^docs/', include_docs_urls(title='My Catalogue of Numbers')),
+
+]

demoproject/urls.py

@@ -0,0 +1,71 @@
+from django.shortcuts import render
+from django.http import HttpResponse
+from django.http import JsonResponse
+from django.http import Http404
+from rest_framework import serializers, viewsets, routers
+from rest_framework.renderers import JSONRenderer
+from rest_framework.response import Response
+
+# This would be served from a database normally.
+# However, as we probably won't use one, this demo shows in-memory data.
+NUMBERS = {1002: {"id": 1002, "name": "One Thousand and two"},
+           39949: {"id": 39949, "name": "Thirty-nine thousand, nine hundred and forty nine"},
+           55: {"id": 55, "name": "Fiffty-five"},
+           28: {"id": 28, "name": "Twenty-eight"}}
+
+
+# Friendly greeting.
+
+def home(request):
+    return HttpResponse("Hello, world.")
+
+
+# Naive JSON API
+# Just to show it's doable.
+
+def naive_numbers(request):
+    return JsonResponse({'numbers': NUMBERS})
+
+def naive_number(request, num_id):
+    number_data = NUMBERS[num_id]
+    try:
+      number_data = NUMBERS[num_id]
+      return JsonResponse({'number': number_data})
+    except KeyError:
+      raise Http404("Number does not exist!")
+
+# Numbers using Using REST API
+
+# The objects we're dealing with.
+class Number(object):
+    def __init__(self, data):
+        self.num_id = data["id"]
+        self.num_name = data["name"]
+
+# For auto API and schema generation.
+class NumberSerializer(serializers.Serializer):
+    num_id = serializers.IntegerField()
+    num_name = serializers.CharField()
+
+class NumberViewSet(viewsets.ViewSet):
+    serializer_class = NumberSerializer
+
+    def list(self, request):
+        # Construct an object for each.
+        nums = [Number(x) for x in NUMBERS.values()]
+
+        serializer = NumberSerializer(nums, many=True)
+        return Response(serializer.data)
+
+    def retrieve(self, request, pk=None):
+        # Look up and construct.
+        number = Number(NUMBERS[int(pk)])
+
+        serializer = NumberSerializer(number)
+        return Response(serializer.data)
+
+
+# Attach the endpoints.
+numbers_router = routers.DefaultRouter()
+numbers_router.register(r'numbers', NumberViewSet, basename='number')
+

demoproject/views.py

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

demoproject/wsgi.py

@@ -0,0 +1,24 @@
+version: '2'
+services:
+
+  # Development server.
+  dev:
+    build: .
+    volumes:
+      - .:/code
+    ports:
+      - "8000:8000"
+    working_dir: /code
+    command: "python manage.py runserver 0.0.0.0:8000"
+
+  # Production server.
+  prod:
+    build: .
+    volumes:
+      - .:/code
+    ports:
+      - "8000:8000"
+    working_dir: /code
+    command: gunicorn demoproject.wsgi:application --bind 0.0.0.0:8000 --workers 3
+
+

docker-compose.yml

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'demoproject.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()

manage.py

@@ -0,0 +1,7 @@
+Django==2.2
+
+
+djangorestframework
+markdown
+django-filter
+coreapi