Django Conventions Project

Welcome to my project on Django Conventions. Below I will try and lay out a list of basic conventions that should be used when creating Reusable Django Applications. Nobody is going to force you to follow these rules, but I think that they will be a good reference point for Best Practices and Conventions. Please contact me if you have any questions or leave comments below. If this page is useful, please feel free to suggest more conventions that are applicable.

This project going to be integrated with django reusable app docs over time. I have a mirror of my sphinx docs here

I have split this up into two separate pages to make things a bit easier.

Coding conventions

  • All code should follow PEP8 as closely as reasonable.
  • All code should preferably follow Django's coding conventions as well.

Django App Conventions

  • This contains Best Practices and information about how to create a good Django Reusable App
  • Where files go
  • What they should look like

Django Project Conventions

  • This contains Best Practies and information about how to create a good Django Project.
  • Project directory Structure
  • Settings file best practices