feat(starter): Initial commit

.gitignore

@@ -0,0 +1,18 @@
+# Django #
+*.log
+*.pot
+*.pyc
+__pycache__
+db.sqlite3
+media
+
+# Python #
+*.py[cod]
+*$py.class
+
+# Visual Studio Code #
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "python.envFile": "${workspaceFolder}/.env"
+}

Dockerfile

@@ -0,0 +1,60 @@
+FROM python:3.6-alpine3.11 AS builder
+
+# Install dependencies
+RUN apk add --update \
+    build-base \
+    g++ \
+    libffi-dev \
+    mariadb-dev
+
+# Add requirements
+ADD requirements.txt /requirements.txt
+
+# Use this until we can safely update to Alpine 3.13 or above
+ENV CRYPTOGRAPHY_DONT_BUILD_RUST=1
+
+# Install Python packages
+RUN pip install -r /requirements.txt
+
+FROM hmsdbmitc/dbmisvc:alpine-python3.6-0.1.0
+
+RUN apk add --no-cache --update \
+    mariadb-connector-c \
+  && rm -rf /var/cache/apk/*
+
+# Copy pip packages from builder
+COPY --from=builder /root/.cache /root/.cache
+
+# Add requirements
+ADD requirements.txt /requirements.txt
+
+# Install Python packages
+RUN pip install -r /requirements.txt
+
+# Copy app source
+COPY /starter /app
+
+# Set the build env
+ENV DBMI_ENV=prod
+
+# Set app parameters
+ENV DBMI_PARAMETER_STORE_PREFIX=
+ENV DBMI_PARAMETER_STORE_PRIORITY=true
+ENV DBMI_AWS_REGION=us-east-1
+
+ENV DBMI_APP_WSGI=starter
+ENV DBMI_APP_ROOT=/app
+ENV DBMI_APP_DB=true
+ENV DBMI_APP_DOMAIN=starter.dbmi.hms.harvard.edu
+
+# Static files
+ENV DBMI_STATIC_FILES=true
+ENV DBMI_APP_STATIC_URL_PATH=/static
+ENV DBMI_APP_STATIC_ROOT=/var/www/static
+
+# Set nginx and network parameters
+ENV DBMI_PORT=443
+ENV DBMI_LB=true
+ENV DBMI_SSL=true
+ENV DBMI_CREATE_SSL=true
+ENV DBMI_HEALTHCHECK=true

docker-compose.yml

@@ -0,0 +1,56 @@
+version: '2.3'
+
+services:
+  db:
+    image: mysql:5.7
+    ports:
+      - '3306'
+    environment:
+      MYSQL_DATABASE: ${DB_DATABASE}
+      MYSQL_USER: ${DB_USER}
+      MYSQL_PASSWORD: ${DB_PASSWORD}
+      MYSQL_ROOT_PASSWORD: ${DB_ROOT_PASSWORD}
+    healthcheck:
+      test: mysqladmin ping -uroot -p"${DB_ROOT_PASSWORD}"
+      interval: 30s
+      timeout: 5s
+      retries: 15
+
+  starter:
+    build: .
+    environment:
+      SECRET_KEY: ${SECRET_KEY}
+      ALLOWED_HOSTS: ${ALLOWED_HOSTS}
+      DB_ENGINE: ${DB_ENGINE}
+      DB_HOST: ${DB_HOST}
+      DB_PORT: ${DB_PORT}
+      DB_DATABASE: ${DB_DATABASE}
+      DB_USER: ${DB_USER}
+      DB_PASSWORD: ${DB_PASSWORD}
+      DBMI_APP_DOMAIN: ${DBMI_APP_DOMAIN}
+      DBMI_PORT: ${DBMI_PORT}
+      DBMI_LB: ${DBMI_LB}
+      DBMI_SSL: ${DBMI_SSL}
+      DBMI_CREATE_SSL: ${DBMI_CREATE_SSL}
+      DBMI_HEALTHCHECK: ${DBMI_HEALTHCHECK}
+      DBMI_APP_STATIC_ROOT: ${DBMI_APP_STATIC_ROOT}
+      GUNICORN_CMD_ARGS: "--log-level info --reload --access-logfile /var/log/gunicorn.log"
+    volumes:
+      - ./starter:/app
+    ports:
+      - "8020:80"
+    depends_on:
+      db:
+        condition: service_healthy
+
+  pma:
+    image: phpmyadmin/phpmyadmin
+    ports:
+      - "8021:80"
+    environment:
+      PMA_HOST: "db"
+      PMA_PORT: 3306
+      MYSQL_ROOT_PASSWORD: "${DB_ROOT_PASSWORD}"
+    depends_on:
+      db:
+        condition: service_healthy

requirements.txt

@@ -0,0 +1,7 @@
+asgiref==3.4.1
+Django==3.2.5
+django-health-check==3.16.4
+djangorestframework==3.12.4
+mysqlclient==2.0.3
+pytz==2021.1
+sqlparse==0.4.1

starter/manage.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', 'starter.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()

starter/starter/asgi.py

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

starter/starter/settings.py

@@ -0,0 +1,131 @@
+"""
+Django settings for starter project.
+
+Generated by 'django-admin startproject' using Django 3.2.5.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+import os
+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.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.environ['SECRET_KEY']
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = os.environ['ALLOWED_HOSTS'].split(",")
+
+
+# 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 = 'starter.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 = 'starter.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": os.environ["DB_ENGINE"],
+        "NAME": os.environ["DB_DATABASE"],
+        "USER": os.environ["DB_USER"],
+        "PASSWORD": os.environ["DB_PASSWORD"],
+        "HOST": os.environ["DB_HOST"],
+        "PORT": os.environ["DB_PORT"],
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.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/3.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/3.2/howto/static-files/
+
+STATIC_URL = os.environ.get('DBMI_APP_STATIC_URL_PATH') + '/'
+STATIC_ROOT = os.environ.get('DBMI_APP_STATIC_ROOT')
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

starter/starter/urls.py

@@ -0,0 +1,21 @@
+"""starter URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/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, re_path, include
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

starter/starter/wsgi.py

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