emilyemorehouse / django-base-template

A Django 1.5 base template with HTML5Boilerplate and Twitter Bootstrap

{% if False %}

Django 1.5 Base Template

About

This template is based off of the work of Mozilla Playdoh and Two Scoops of Django, as well as experience with other Django layouts/project templates. Playdoh is mainly setup for Mozilla's systems, and is currently only designed for Django 1.4.

This project template is designed for Django 1.4's new startproject template option. This version of the project template is designed for Django 1.5.

As much as I could, all the code has been updated to use the new suggested layout and functionality in Django 1.5.

Features

By default, this project template includes:

A set of basic templates built from HTML5Boilerplate 4.1.0 and Twitter Bootstrap 2.3.1 (located in the base app)

Templating:

• Markdown
• django_compressor for compressing javascript/css/less/sass

Security:

• bleach
• python-bcrypt2 - uses bcrypt for password hashing by default

Background Tasks:

• Celery

Migrations:

• South

Caching:

• python-memcached

Admin:

• Includes django-admin-toolbar for development and production (enabled for superusers)
• Includes django-debug-toolbar-user-panel, which is quite useful, but is disabled until it fully supports Django 1.5

Testing:

• nose and django-nose
• pylint, pep8, and coverage

Any of these options can added, modified, or removed as you like after creating your project.

How to use this project template to create your project

• Create your working environment and virtualenv
• Install Django 1.5 ($ pip install Django>=1.5)
• $ django-admin.py startproject --template https://github.com/xenith/django-base-template/zipball/master --extension py,md,rst projectname
• $ cd projectname
• Uncomment your preferred database adapter in requirements/compiled.txt (MySQL, Postgresql, or skip this step to stick with SQLite)
• $ pip install -r requirements/local.txt
• $ cp projectname/settings/local-dist.py projectname/settings/local.py
• $ python manage.py syncdb
• $ python manage.py migrate
• $ python manage.py runserver

That's all you need to do to get the project ready for development. When you deploy your project into production, you should look into getting certain settings from environment variables or other external sources. (See SECRET_KEY for an example.)

There isn't a need to add settings/local.py to your source control, but there are multiple schools of thought on this. The method I use here is an example where each developer has their own settings/local.py with machine-specific settings. You will also need to create a version of settings/local.py for use in deployment that you will put into place with your deployment system (Fabric, chef, puppet, etc).

The second school of thought is that all settings should be versioned, so that as much of the code/settings as possible is the same across all developers and test/production servers. If you prefer this method, then make sure all necessary settings are properly set in settings/base.py, and then edit settings/init.py so it no longer reraises the exception. (ie, by replacing 'raise' with 'pass'). As it is, settings/local.py should only be overriding settings from settings/base.py anyway. (You could also just set the DJANGO_SETTINGS_MODULE environment variable to "{{ project_name }}.settings.base" directly.)

{% endif %}

The {{ project_name|title }} Project

About

Describe your project here.

Prerequisites

• Python 2.6 or 2.7
• pip
• virtualenv (virtualenvwrapper is recommended for use during development)

Installation

Fill out with installation instructions for your project.

License

This software is licensed under the New BSD License. For more information, read the file LICENSE.