Add of a configuration system

I added a better configuration system in order to take into account for
local development, staging or production deployments.

Signed-off-by: Matthieu Berjon <matthieu.berjon@inria.fr>

django/config/settings/base.py

+"""
+Base settings to build other settings files upon
+"""
+
+import environ
+
+ROOT_DIR = environ.Path(__file__) - 3
+APPS_DIR = ROOT_DIR.path('allgo')
+
+env = environ.Env()
+
+READ_DOT_ENV_FILE = env.bool('DJANGO_READ_DOT_ENV_FILE', default=True)
+if READ_DOT_ENV_FILE:
+    # OS environment variables take precedence over variables from .env
+    env.read_env(str(ROOT_DIR.path('.env')))
+
+
+# GENERAL
+# ------------------------------------------------------------------------------
+DEBUG = env.bool('DJANGO_DEBUG', False)
+
+TIME_ZONE = 'UTC'
+LANGUAGE_CODE = 'en-us'
+SITE_ID = 1
+USE_I18N = True
+USE_L10N = True
+USE_TZ = True
+
+
+# DATABASES
+# ------------------------------------------------------------------------------
+DATABASES = {
+        'default': env.db('DATABASE_URL', default='mysql:///localhost'),
+        }
+DATABASES['default']['ATOMIC_REQUESTS'] = True
+
+
+# URLS
+# ------------------------------------------------------------------------------
+ROOT_URLCONF = 'config.urls'
+WSGI_APPLICATION = 'config.wsgi.application'
+
+
+# APPS
+# ------------------------------------------------------------------------------
+DJANGO_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+THIRD_PARTY_APPS = []
+LOCAL_APPS = [
+        'poc',
+]
+
+INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
+
+
+# MIGRATIONS
+# ------------------------------------------------------------------------------
+MIGRATION_MODULES = {
+        'sites': 'django.contrib.sites.migrations'
+}
+
+
+# AUTHENTIFICATION
+# ------------------------------------------------------------------------------
+AUTHENTIFICATION_BACKENDS = [
+        'django.contrib.auth.backends.ModelBackend',
+]
+LOGIN_REDIRECT_URL = 'poc_home'
+LOGOUT_REDIRECT_URL = 'poc_home'
+
+
+# PASSWORDS
+# ------------------------------------------------------------------------------
+PASSWORD_HASHERS = [
+        'django.contrib.auth.hashers.PBKDF2PasswordHasher',
+        'django.contrib.auth.hashers.PBKDF2SHA1PasswordHasher',
+        'django.contrib.auth.hashers.BCryptSHA256PasswordHasher',
+        'django.contrib.auth.hashers.BCryptPasswordHasher',
+]
+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',
+        },
+]
+
+
+# MIDDLEWARE
+# ------------------------------------------------------------------------------
+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',
+]
+
+
+# STATIC
+# ------------------------------------------------------------------------------
+STATIC_ROOT = str(ROOT_DIR('static'))
+STATIC_URL = '/static/'
+STATICFILES_DIRS = [
+    str(APPS_DIR.path('static')),
+]
+STATICFILES_FINDERS = [
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+]
+
+
+# MEDIA
+# ------------------------------------------------------------------------------
+MEDIA_ROOT = str(APPS_DIR('media'))
+MEDIA_URL = '/media/'
+
+
+# TEMPLATES
+# ------------------------------------------------------------------------------
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [
+            str(APPS_DIR.path('templates')),
+        ],
+        'OPTIONS': {
+            'debug': DEBUG,
+            'loaders': [
+                'django.template.loaders.filesystem.Loader',
+                'django.template.loaders.app_directories.Loader',
+            ],
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.template.context_processors.media',
+                'django.template.context_processors.i18n',
+                'django.template.context_processors.static',
+                'django.template.context_processors.tz',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+
+# EMAIL
+# ------------------------------------------------------------------------------
+EMAIL_BACKEND = env('DJANGO_EMAIL_BACKEND', default='django.core.mail.backends.smtp.EmailBackend')
+
+
+# ADMIN
+# ------------------------------------------------------------------------------
+ADMIN_URL = r'^admin/'
+ADMINS = [
+    ("""Matthieu Berjon""", 'matthieu.berjon@inria.fr'),
+]
+MANAGERS = ADMINS
+
+
+# MY STUFF

django/config/settings/local.py

+from .base import *
+from .base import env
+
+
+# GENERAL
+# ------------------------------------------------------------------------------
+DEBUG = env.bool('DJANGO_DEBUG', default=True)
+SECRET_KEY = env('DJANGO_SECRET_KEY', default='xVSW3WcdFQvbZokBVjnE3PWzEMUtEfuFe5kCg8Oyqk1Gt4bt5PVi3DEuV2xehEPp')
+ALLEWED_HOSTS = [
+    "localhost",
+    "0.0.0.0",
+    "127.0.0.1",
+]
+
+
+# TEMPLATES
+# ------------------------------------------------------------------------------
+TEMPLATES[0]['OPTIONS']['debug'] = DEBUG
+
+
+# EMAILS
+# ------------------------------------------------------------------------------
+EMAILS_BACKEND = env('DJANGO_EMAIL_BACKEND', default='django.core.mail.backends.console.EmailBackend')
+EMAIL_HOST = 'localhost'
+EMAIL_PORT = 1025
+
+
+# MY STUFF
+# ------------------------------------------------------------------------------

django/config/settings/staging.py

+import logging
+
+from .base import *
+from .base import env
+
+# GENERAL
+# ------------------------------------------------------------------------------
+SECRET_KEY = env('DJANGO_SECRET_KEY')
+ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=['localhost'])
+
+
+# DATABASES
+# ------------------------------------------------------------------------------
+DATABASES['default'] = env.db('DATABASE_URL')
+DATABASES['default']['ATOMIC_REQUESTS'] = True
+DATABASES['default']['CONN_MAX_AGE'] = env.int('CONN_MAX_AGE', default=60)
+
+
+# SECURITY
+# ------------------------------------------------------------------------------

django/config/urls.py

+from django.conf import settings
+from django.conf.urls import include, url
+from django.conf.urls.static import static
+from django.contrib import admin
+from django.views import defaults as default_views
+
+urlpatterns = [
+    # Django admin
+    url(settings.ADMIN_URL, admin.site.urls),
+
+    # Allgo stuff here
+    url(r'', include('poc.urls')),
+
+] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+
+if settings.DEBUG:
+    urlpatterns += [
+        url(r'^400/$', default_views.bad_request, kwargs={'exception': Exception('Bad Request!')}),
+        url(r'^403/$', default_views.permission_denied, kwargs={'exception': Exception('Permission denied!')}),
+        url(r'^404/$', default_views.page_not_found, kwargs={'exception': Exception('Page not found!')}),
+        url(r'^500/$', default_views.server_error),
+    ]

django/config/wsgi.py

+import os
+import sys
+
+from django.core.wsgi import get_wsgi_application
+
+
+app_path = os.path.abspath(os.path.join(
+    os.path.dirname(os.path.abspath(__file__)), os.pardir))
+sys.path.append(os.path.join(app_path, 'django'))
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.production')
+
+application = get_wsgi_application()

django/manage.py

@@ -3,7 +3,7 @@ import os
 import sys
 
 if __name__ == "__main__":
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "allgo.settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local")
     try:
         from django.core.management import execute_from_command_line
     except ImportError:
@@ -19,4 +19,7 @@ if __name__ == "__main__":
                 "forget to activate a virtual environment?"
             )
         raise
+
+    current_path = os.path.dirname(os.path.abspath(__file__))
+    sys.path.append(os.path.join(current_path, 'allgo'))
     execute_from_command_line(sys.argv)