Initial commit

.gitignore

@@ -0,0 +1,138 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

Dockerfile

@@ -0,0 +1,25 @@
+# syntax=docker/dockerfile:1
+FROM alpine:3.14 as base
+run apk --no-cache add python3 py3-pip py3-cryptography py3-psycopg2
+ENV PYTHONUNBUFFERED=1
+
+FROM base as pythonDeps
+
+ENV PYTHONFAULTHANDLER=1 \
+  PYTHONUNBUFFERED=1 \
+  PYTHONHASHSEED=random \
+  PIP_NO_CACHE_DIR=off \
+  PIP_DISABLE_PIP_VERSION_CHECK=on \
+  PIP_DEFAULT_TIMEOUT=100
+
+RUN pip3 install poetry
+
+# Copy only requirements to cache them in docker layer
+WORKDIR /code/
+COPY ./requirements.txt /code/requirements.txt
+RUN pip3 install -r requirements.txt
+
+from pythonDeps as final
+
+# Bake code directory into the app
+copy ./ /code/

README.md

@@ -0,0 +1,15 @@
+A base django project for dockerized django. Intended to make creating quick
+django docker apps very easy for me. Prefered databases are postgres and
+cockroachdb.
+
+    docker-compose -f docker-develop.yaml up --build
+
+### Environment variables
+
+Read the `djangobase/default_environment.env` file for a full list of environment
+variables and their defaults. Environment variables are taken from the actual 
+environment, the .env file, and finally the defaultEnv file.
+
+### ToDo
+
+ - [ ] Plugable authentication via env variables (ldap at the very least)

djangobase/Settings/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for Settings 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', 'Settings.settings')
+
+application = get_asgi_application()

djangobase/Settings/settings.py

@@ -0,0 +1,132 @@
+"""
+Django settings for Settings 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/
+"""
+
+from pathlib import Path
+import os
+
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+from dotenv import load_dotenv
+load_dotenv()
+load_dotenv(BASE_DIR/'default_environment.env')
+
+# 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 = bool(os.environ['DEBUG'])
+
+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',
+    'first_run',
+]
+
+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 = 'Settings.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 = 'Settings.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+# As per https://github.com/jacobian/dj-database-url
+
+import dj_database_url
+#Monkey patch in support for cockroachdb
+dj_database_url.SCHEMES['cockroach']='django_cockroachdb'
+
+DATABASES={}
+
+DATABASES['default'] = dj_database_url.config(conn_max_age=600)
+
+# 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 = os.environ['LANGUAGE_CODE']
+
+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 = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

djangobase/Settings/urls.py

@@ -0,0 +1,22 @@
+"""Settings 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, include
+
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

djangobase/Settings/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for Settings 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', 'Settings.settings')
+
+application = get_wsgi_application()

djangobase/default_environment.env

@@ -0,0 +1,12 @@
+ALLOWED_HOSTS=localhost, #Comma seperated list of hostnames
+DEBUG=1 #0 for false
+
+#####      It's very important that you change this     #####
+# You can generate a new secret key with
+# python -c "import secrets; print(secrets.token_urlsafe())"
+
+SECRET_KEY=Changeme #Used to sign session cookies, a bad secret key could allow for impersonating users.
+
+LANGUAGE_CODE=en-us
+
+DATABASE_URL=sqlite://db.sqlite

djangobase/first_run/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

djangobase/first_run/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class FirstRunConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'first_run'

djangobase/first_run/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

djangobase/first_run/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

djangobase/first_run/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

djangobase/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', 'Settings.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()

docker-develop.yaml

@@ -0,0 +1,33 @@
+version: "3.7"
+   
+services:
+  db:
+    image: postgres
+    volumes:
+      - ./data/db:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB=djangoApp
+      - POSTGRES_USER=django
+      - POSTGRES_PASSWORD=postgres_changeme
+  web:
+    build:
+      context: ./
+      target: pythonDeps #Don't include our actual source code in the image
+
+    command: |
+        sh -c "
+        while ! nc -z db 5432; do sleep 0.2; done; #Wait for postgres to start
+        python3 djangobase/manage.py migrate
+        python3 djangobase/manage.py runserver 0.0.0.0:8000"
+
+    environment:
+      DATABASE_URL: postgres://django:postgres_changeme@db:5432/djangoApp
+      SECRET_KEY: Changeme #Very important that you change this.
+      #Generate a new one with: python -c "import secrets; print(secrets.token_urlsafe())"
+
+    volumes:
+      - ./:/code
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db

docker-example-production.yaml

@@ -0,0 +1,28 @@
+version: "3.7"
+   
+services:
+  db:
+    image: postgres
+    volumes:
+      - ./data/db:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB=djangoApp
+      - POSTGRES_USER=django
+      - POSTGRES_PASSWORD=password
+  web:
+    build:
+      context: ./
+      target: final
+
+    command: >
+        sh -c "python3 djangobase/manage.py migrate &&
+        gunicorn djangobase.Settings.wsgi"
+    environment:
+      DATABASE_URL: postgres://django:password@db:5432/djangoApp
+      SECRET_KEY: Changeme #Very important that you change this.
+      #Generate a new one with: python -c "import secrets; print(secrets.token_urlsafe())"
+
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db

requirements.txt

@@ -0,0 +1,5 @@
+django==3.*
+django-cockroachdb==3.*
+python-dotenv==0.18.*
+dj-database-url==0.5.0
+gunicorn==20.*

tests/test_djangobase.py

@@ -0,0 +1,5 @@
+from djangobase import __version__
+
+
+def test_version():
+    assert __version__ == '0.1.0'