Quick Start

Here is quick primer on creation of new Django project (mysql+south+html5boilerplate) that supports deployment to vagrant-managed virtual box.

First, install everything:

$ pip install django-fab-templates
$ gem install vagrant
$ vagrant box add lucid32 http://files.vagrantup.com/lucid32.box

Then create new Django project, boot and configure vagrant box:

$ paster create -t vagrant_project my_project
$ cd my_project
$ vagrant up

Finally set up your project on virtual vagrant box and test it:

$ fab vagrant setup
$ curl -I http://localhost:8080/

Features

All project templates have the following in common:

• Automated deployment with help of Fabric command-line tool is supported

• Excellent html5 boilerplate template is used as a base for html+css+js

• SQLite and MySQL are used as default db backends

• Database scheme and data migrations are managed by South

• Multiple configurations (development/staging/production) and local setting overrides are supported

The following major fab commands are supported in all projects:

• Webserver manipulation

  • apache_restart - Restarts apache

  • apache_start - Starts apache

  • apache_stop - Stops apache

  • maintenance_off - Turn maintenance mode off

  • maintenance_on - Turn maintenance mode on

• Database

  • create_database - Create database and db user

  • drop_database - Create database and db user

  • populate_database - Create initial database scheme and load initial data

  • migrate - Migrate database scheme and data

$ paster create -t vagrant_project my_project
$ cd my_project
$ vagrant up
$ fab vagrant setup

Dependencies

django-fab-templates requires the following python packages:

• setuptools - no comments

• PasteScript - pluggable command-line frontend, including commands to setup package file layouts

• Cheetah - a template engine and code generation tool

• Fabric - command-line automation tool

• Jinja2 - modern and designer friendly templating language for Python

Installation

From pypi:

$ pip install django-fab-templates

or:

$ easy_install django-fab-templates

or clone from GitHub and install manually:

$ git clone git://github.com/dreamiurg/django-fab-templates.git
$ cd django-fab-templates
$ sudo python setup.py install

Usage

To see list of available project templates:

$ paster create --list-templates

To generate Django project template:

$ paster create -t <template_name> <project_name>