jpadilla / django-project-template

Project template layout for Django 3.0+

Django 3.0+ project template

This is a simple Django 3.0+ project template with my preferred setup. Most Django project templates make way too many assumptions or are just way too complicated. I try to make the least amount of assumptions possible while still trying provide a useful setup. Most of my projects are deployed to Heroku, so this is optimized for that but is not necessary.

Features

• Django 3.0+
• Uses Pipenv - the officially recommended Python packaging tool from Python.org.
• Development, Staging and Production settings with django-configurations.
• Get value insight and debug information while on Development with django-debug-toolbar.
• Collection of custom extensions with django-extensions.
• HTTPS and other security related settings on Staging and Production.
• Procfile for running gunicorn with New Relic's Python agent.
• PostgreSQL database support with psycopg2.

How to install

$ django-admin.py startproject \
  --template=https://github.com/jpadilla/django-project-template/archive/master.zip \
  --name=Procfile \
  --extension=py,md,env \
  project_name
$ mv example.env .env
$ pipenv install --dev

Environment variables

These are common between environments. The ENVIRONMENT variable loads the correct settings, possible values are: DEVELOPMENT, STAGING, PRODUCTION.

ENVIRONMENT='DEVELOPMENT'
DJANGO_SECRET_KEY='dont-tell-eve'
DJANGO_DEBUG='yes'

These settings(and their default values) are only used on staging and production environments.

DJANGO_SESSION_COOKIE_SECURE='yes'
DJANGO_SECURE_BROWSER_XSS_FILTER='yes'
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF='yes'
DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS='yes'
DJANGO_SECURE_HSTS_SECONDS=31536000
DJANGO_SECURE_REDIRECT_EXEMPT=''
DJANGO_SECURE_SSL_HOST=''
DJANGO_SECURE_SSL_REDIRECT='yes'
DJANGO_SECURE_PROXY_SSL_HEADER='HTTP_X_FORWARDED_PROTO,https'

Deployment

It is possible to deploy to Heroku or to your own server.

Heroku

$ heroku create
$ heroku addons:add heroku-postgresql:hobby-dev
$ heroku pg:promote DATABASE_URL
$ heroku config:set ENVIRONMENT=PRODUCTION
$ heroku config:set DJANGO_SECRET_KEY=`./manage.py generate_secret_key`

License

The MIT License (MIT)

Copyright (c) 2012-2017 José Padilla

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

django-project-template's Issues

install dev requirements

We should add:
-r common.txt

to the requirements/dev.txt file in order to install all dependencies.

Select DB when creating project

Could you please provide options for selecting DB when creating project via django-admin.py createproject...
I want to be able create new project with SQLite instead of PostgreSQL

Add WhiteNoise

http://whitenoise.evans.io/en/stable/index.html

please create a documentation

Accessing Secret_KEY

Hello I just discover your template and I try to run it in my local environment. I type the command "python manage.py startapp app_name" and I get this error:
raise ValueError('Value {0!r} is required to be set as the '
ValueError: Couldn't setup configuration 'MyApp_name.settings.Development': Value 'SECRET_KEY' is required to be set as the environment variable 'DJANGO_SECRET_KEY'

structlog

http://www.structlog.org/en/stable/index.html

Maybe need add debug toolbar in class Development(Common) ?

django-configurations version 2.0, using configuration 'Development'
django.core.management.base.SystemCheckError: SystemCheckError: System check identified some issues:

ERRORS:
?: debug_toolbar.middleware.DebugToolbarMiddleware is missing from MIDDLEWARE_CLASSES.
HINT: Add debug_toolbar.middleware.DebugToolbarMiddleware to MIDDLEWARE_CLASSES.

Custom user model

Specify a custom user model as recommended in https://docs.djangoproject.com/en/1.11/topics/auth/customizing/#auth-custom-user

Alternates to use of pipenv?

I had not used pipenv before encountering your project, and it seems a fairly non-intuitive project to use (e.g. pypa/pipenv#1035 and similar ) for those of us used to virtualenv. I like the idea of a templated Django project; is there any option to use the more common way of setting this up that does not involve pipenv?

Use pipenv .env loading feature

Replace "psycopg2" package name

Need to replace "psycopg2" with "psycopg2-binary".

Check the following warning:

lib/python3.7/site-packages/psycopg2/__init__.py:144: UserWarning: The psycopg2 wheel package will be renamed from release 2.8; in order to keep installing from binary please use "pip install psycopg2-binary" instead. For details see: <http://initd.org/psycopg/docs/install.html#binary-install-from-pypi>.

Update for Django 1.8

Pipenv-ify

Add django-flat-theme

Update for Django 2.0

https://docs.djangoproject.com/en/2.0/releases/2.0/

Finish this

With Whitenoise

Hello,

I want to serve my staticfiles with whitenoise on heroku. When I implement it just like that : https://devcenter.heroku.com/articles/django-assets
I have this complete trace :
http://pastebin.com/r7iCXVwu

And, here the complete settings :
http://pastebin.com/DYX89Q3k

What should I do ?
I just want to serve statics in heroku.

Thank you :).

bump dependapot

Handle error accessing .env file

I stumbled into an error caused by a typo in wsgi.py which prevented the settings from .env being imported. Since errors are not handled it took me days to find the actual problem. Therefore, I suggest you introduce some kind of error handling to notify the user.

I introduced an AttributeError as shown below. You might wanna replace it with a more general error class.

try:
    dotenv.read_dotenv(
        os.path.join(os.path.dirname(os.path.dirname(__file__)), '.env'))
except AttributeError as e:
    print "Error reading .env: {0}".format(e)
    pass

Procfile is not configured correctly

When I created a new project using this template my Procfile remained like this:

web: newrelic-admin run-program gunicorn -b "0.0.0.0:$PORT" -w 3 {{ project_name }}.wsgi

And I had to change the {{ project_name }} manually. Don't know if it's an easy fix, but worth mentioning.