README.rst

cookiecutter-django-project

A fully tested Cookiecutter template we use for Django projects at transcode.

Batteries included

• Django 1.8
• Initializr 4.0 HTML5 template

  • Bootstrap 3.1.1
  • HTML5 Boilerplate 4.3.0
  • jQuery 1.11.0

• django-braces
• django-crispy-forms
• django-grappelli
• django-model-utils
• psycopg2
• Sphinx

Configuration

• django-configurations
• dj-database-url
• envdir

Development Tools

• bumpversion
• django-debug-toolbar
• django-devserver

  • sqlparse
  • Werkzeug

• Glances
• IPython
• pdb++
• pg_activity

Lint Tools

• check-manifest
• doc8
• flake8
• isort
• pep257

Testing

• coverage
• django-coverage-plugin
• factory_boy
• freezegun
• pytest
• pytest-django
• pytest-factoryboy
• tox
• tox-pyenv

Creating a new Project

First you have to install Cookiecutter:

$ pip install cookiecutter

After that change to the directory where you want to create a your new Django project in. Then set up the project using this cookiecutter template like so:

$ cookiecutter gh:transcode-de/cookiecutter-django-project

You have to answer a few questions to configure the project. The defaults are good for transcode projects - surely you want to override them for your projects.

Next Steps

Change into your newly created project directory and execute the following commands to get started.

Install the packages for development:

$ make develop

Then create the new PostgreSQL user and database:

$ make create-db

The next step is to create the Django app(s) you want for the project. Just run the startapp task to create new Django app(s):

$ make startapp

Now create the database tables:

$ make migrate

And start the development webserver:

$ make runserver

To see the other targets available in the Makefile simply run:

$ make

License

This project is licensed under the New BSD License. See LICENSE for the full license.