commit 10fc14eb7ab4e3452db018342160a62eb5c44bb2 Author: Abubakar Abid Date: Wed Sep 19 07:30:40 2018 -0700 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..2f783ab6c7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +venv +*.pyc +staticfiles +.env +*.sqlite3 diff --git a/Pipfile b/Pipfile new file mode 100644 index 0000000000..77827ab385 --- /dev/null +++ b/Pipfile @@ -0,0 +1,21 @@ +[[source]] + +url = "https://pypi.python.org/simple" +verify_ssl = true +name = "pypi" + + +[requires] + +python_version = "3.6" + + +[packages] + +"psycopg2-binary" = "*" +django-heroku = "*" +gunicorn = "*" + + +[dev-packages] + diff --git a/Procfile b/Procfile new file mode 100644 index 0000000000..9129fc6e6d --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn gradiome.wsgi diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ac6335ab43 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Heroku Django Starter Template + +An utterly fantastic project starter template for Django 2.0. + +## Features + +- Production-ready configuration for Static Files, Database Settings, Gunicorn, etc. +- Enhancements to Django's static file serving functionality via WhiteNoise. +- Latest Python 3.6 runtime environment. + +## How to Use + +To use this project, follow these steps: + +1. Create your working environment. +2. Install Django (`$ pipenv install django`) +3. Create a new project using this template + +## Creating Your Project + +Using this template to create a new Django app is easy:: + + $ django-admin.py startproject --template=https://github.com/heroku/heroku-django-template/archive/master.zip --name=Procfile helloworld + +(If this doesn't work on windows, replace `django-admin.py` with `django-admin`) + +You can replace ``helloworld`` with your desired project name. + +## Deployment to Heroku + + $ git init + $ git add -A + $ git commit -m "Initial commit" + + $ heroku create + $ git push heroku master + + $ heroku run python manage.py migrate + +See also, a [ready-made application](https://github.com/heroku/python-getting-started), ready to deploy. + + +## License: MIT + +## Further Reading + +- [Gunicorn](https://warehouse.python.org/project/gunicorn/) +- [WhiteNoise](https://warehouse.python.org/project/whitenoise/) +- [dj-database-url](https://warehouse.python.org/project/dj-database-url/) diff --git a/gradiome/__init__.py b/gradiome/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/gradiome/settings.py b/gradiome/settings.py new file mode 100644 index 0000000000..8a0e95fc28 --- /dev/null +++ b/gradiome/settings.py @@ -0,0 +1,137 @@ +""" +Django settings for gradiome project on Heroku. For more info, see: +https://github.com/heroku/heroku-django-template + +For more information on this file, see +https://docs.djangoproject.com/en/2.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/2.0/ref/settings/ +""" + +import os +import dj_database_url +import django_heroku + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__)) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = "6j1czr8nnw963un68*=10q&z^un2*&wjxmy%aef2%a&@aj$+f4" + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + # Disable Django's own staticfiles handling in favour of WhiteNoise, for + # greater consistency between gunicorn and `./manage.py runserver`. See: + # http://whitenoise.evans.io/en/stable/django.html#using-whitenoise-in-development + 'whitenoise.runserver_nostatic', + 'django.contrib.staticfiles', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'whitenoise.middleware.WhiteNoiseMiddleware', + '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 = 'gradiome.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', + ], + 'debug': DEBUG, + }, + }, +] + +WSGI_APPLICATION = 'gradiome.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/2.0/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + } +} + +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.0/topics/i18n/ + +LANGUAGE_CODE = 'en-us' +TIME_ZONE = 'UTC' +USE_I18N = True +USE_L10N = True +USE_TZ = True + +# Change 'default' database configuration with $DATABASE_URL. +DATABASES['default'].update(dj_database_url.config(conn_max_age=500, ssl_require=True)) + +# Honor the 'X-Forwarded-Proto' header for request.is_secure() +SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') + +# Allow all host headers +ALLOWED_HOSTS = ['*'] + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/2.0/howto/static-files/ + +STATIC_ROOT = os.path.join(PROJECT_ROOT, 'staticfiles') +STATIC_URL = '/static/' + +# Extra places for collectstatic to find static files. +STATICFILES_DIRS = [ + os.path.join(PROJECT_ROOT, 'static'), +] + +# Simplified static file serving. +# https://warehouse.python.org/project/whitenoise/ +STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage' + +# Activate Django-Heroku. +django_heroku.settings(locals()) diff --git a/gradiome/static/humans.txt b/gradiome/static/humans.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/gradiome/urls.py b/gradiome/urls.py new file mode 100644 index 0000000000..f3a32be1f2 --- /dev/null +++ b/gradiome/urls.py @@ -0,0 +1,22 @@ +"""gradiome URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/2.0/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 --git a/gradiome/wsgi.py b/gradiome/wsgi.py new file mode 100644 index 0000000000..56ccf310c5 --- /dev/null +++ b/gradiome/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for gradiome 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.0/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "gradiome.settings") + +application = get_wsgi_application() diff --git a/manage.py b/manage.py new file mode 100644 index 0000000000..fbd6a833c1 --- /dev/null +++ b/manage.py @@ -0,0 +1,15 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "gradiome.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?" + ) + execute_from_command_line(sys.argv)