Django Wiki

The source of documentation, examples, extensions and code snippets

Django is available open-source under the ​BSD license.

Browsing code online

• Browse source: See the full code via a Web interface.
• Timeline: Keep track of recent changes.
• See our ​download page for download instructions.

Sites using Django

• Django-powered sites: List your Django powered site(s) here!

Getting involved

• ​How to contribute to Django: The lowdown on how our community works.
• [report:1 Tickets]: View active tickets, make bug reports and contribute feature requests.
• Little, easy improvements: Get your feet wet by taking on one of these small tasks.
• ​How to report security issues: How to report security issues

In Development

This category describes changes and some new features introduced in the development version of Django:

• ActiveBranches: A list of active branches where new features are being developed.
• ModelInheritance: Write-up discussing how inheritance/subclassing of models should work. Currently this is not implemented in the development version of Django, so if you need model subclassing stick to one of the older stable releases or use workarounds like one-to-one relationships.
• SchemaEvolution: This is a new feature, under development as a project for the 2006 Summer of Code.
• RowLevelPermissions: Currently Django's permission system only works at the level of an entire model -- e.g., user "Bob" has access to add flatpages and edit users. This Summer of Code project will extend the permission system to be much more fine-grained, so permissions will be able to be assigned per object instead of per model (so, for example, user "Bob" could be given permission to edit only flatpage number 24 and user number 12, instead of all flatpages and all users).
• GenericAuthorization: A more flexible authorization system for Django. The new system should allow for ACL's, role-based systems, and Django's current model-level permissions.
• Generic relations: a "generic foreign key" feature is currently under development, but not yet completed. There is no support for it yet in the admin application, and it is probably unwise to attempt to use it in a production application.
• FullHistory: A "full content history" implementation with compare, revert, etc. A SoC 2006 project.
• TextIndexingAbstractionLayer: An abstraction layer for full-text indexing and search engines such as Lucene, Xapian, and Hyper Estraier. Also known as Merquery, this Summer of Code project will most likely be placed in contrib.search.

Descriptions of major changes to the codebase

• Backwards Incompatible Changes: Comprehensive list of backwards-incompatible changes made since first public release.
• Removing the magic: The magic-removal branch was merged to trunk in changeset [2809], May 2006.
• New-admin changes: The new-admin branch was merged to trunk in changeset [1433], November 2005.

Example applications (with source code/templates)

• ​Django Based projects at google - See django based projects hosted at code.google.com

• djangoproject.com: See the full code and templates for the Django-powered portions of this site (i.e., everything except the ticket system). The Python code is available under the BSD license, but the templates are copyrighted by World Online and shouldn't be copied.
• ​Diamanda Wiki and MyghtyBoard Forum: source of a GPL wiki and forum script.
• ​Custard/Melt: Source code for application developed using Django.
• ​Django Photo Gallery : Source for a "Gallery with a twist" (by Georg Bauer)
• ​Source for A simple CMS : written with Django (Georg Bauer) ( A site ​http://rfc1437.de/ : using this simple CMS system.)
• ​Source for an IRCLogger : done in Django (Georg Bauer)
• ​WorkStyle - GTD TODO Management Application. ​sandbox is available too.
• ​Zyons - Forum/Community application.
• ​stockphoto - A simple photo gallery (by Jason McBrayer)
• ​Feedjack - A Planet/feed aggregator application by Gustavo Picón. Sample sites: (​1, ​2, ​3)
• ​Generic Pastebin App - Source tarball available for a pastebin application completely driven by generic views, no custom view code.
• ​FFSomething - Suite for managing open wireless mesh networks
• ​BookMaker - Bookmaker is an open-source web application for managing small parimutuel betting pools ( ​Browse BookMaker Source )
• ​RISE Project (Resources and Information for Success in Education) - a project to manage and publish academic catalog information including programs, courses, and schedules. (BSD-licensed.)
• ​Ip to country application - this application will allow you to get the country flag of comments.
• ​notmm - a multi-purpose application toolkit on top of Django. (Apache License Version 2.0 and BSD-style license compatible)
• ​FileBrowser - an extension to the Django Admin-Interface

Contributed documentation and examples

General

• ​Compilation of Tutorials: Intended to be a complete and concise list of Django tutorials
• CookBook: Code recipes.
• CommonPitfalls: Common developer errors, gotchas, etc.
• DocumentationSuggestions: A place to put docs that you wish you could have found while learning
• Do's and Dont's for application writers: how to make an application that is easy to distribute
• ​Django API (Beta): Automatic generated API using epydoc
• FormField documentation for Manipulators
• ExtendedUserModel: How to extend the auth systems's User class to contain extra data. (Warning: kludge!)
• Making Custom form fields: Adventures in making new form fields.
• Custom Upload Fields with Template Filters: extra features for upload fields.
• Developer Documentation: Documentation about the internals of Django.
• User-contributed middleware
• ​Djangoutils: Miscellaneous Django utilities.
• Initial SQL data using Django ORM: How to do it.
• Using Django and PureFTPd: How to use Django's user database in PureFTPd. Surprisingly painless.
• ​Django & Open Office: An example of how to use Django and Open Office to do advance document templating.

Installing and Configuring Django

• Server arrangements: How to use Django with FCGI, Twisted, etc.
• Setup on Mac OS X Tiger: Includes installing python 2.4 (which isn't required), the latest version of postgresql, and psycopg.
• WindowsInstall - install django on Windows in 5 minutes (using sqlite and the internal webserver)
• ​Django, lighttpd and FastCGI: A book-like documentation about running django with Lighttpd
• MovablePythonInstall - install Django on a USB stick using Movable Python

Development environment

• Simple Bash Script To Setup Development Environment: An example of how to set up your development environment.
• 'django-settings' Bash function: Save the typing of DJANGO_SETTINGS_MODULE.
• Django development with Vim: Hints and tips for using the Vim editor.
• A python script for parsing settings.py: A small python script can be used to read, modify, save settings.py file.
• A python script for parsing urls.py: A small python script can be used to read, modify, save urls.py file.
• Profiling Django: How to use the Python hotshot profiler with Django
• Greasemonkey script for djangoproject.com: Shortens titles to faciliate better tab browsing of Django's documentation

Templates

• ExtendingAdminTemplates
• TemplateTagsCheatSheet - A quick list of all the template tags.
• Using Myghty Templates in Django - How to use Myghty templates in Django
• ​Zope3 Page Templates for Django – Add-on allowing to use ZPT in Django
• PHP template loader - Integrate Django templates into an existing PHP based site
• ​Cheetah template for django: Generic views + cheetah's admin functions. Contact dj@…. (BROKEN LINK)

Code Examples

• Ajax/DHTML shopping basket in Django example
• ContentBBcode Parser - How-to make pluggable special-tag parser
• Reading Binary Files - How to read Baldurs Gate II character files and display data about the character
• Ajax and Django, using Dojo How to submit a form using Ajax with Dojo.
• Ajax and Django, using YUI How to make ajax work with Django with Yahoo! UI Library.
• ​LDAP Django Auth Backend: Dead-Simple LDAP in Django with Backends
• Add Dojo Editor: How to add a rich-text editor to administration pages with Dojo.
• Custom TinyMCE Widget: How to create a custom TinyMCE widget using django.newforms
• Simple 'scaffolding': Spew out simple form fields as a base for modification
• More about scaffolding: Spew out simple forms for your whole app, including automated urls
• Generic URL Generator: Generate URLs when using generic views
• Model 'middleware': Add pre/post save/delete callbacks to any model.
• Simple Custom Manipulators: Spews out a custom manipulator for your model, primed and ready for tweaking.
• Auto All-Apps Module: Simple package with all the installed app modules underneith it.
• Safe Settings context processor: Provide template access to your settings variables.

Web Services/APIs

• A Google search engine front end in Django tutorial
• XML-RPC Example of doing XML-RPC in Django
• JSON-RPC Example of doing JSON-RPC in Django
• WebServices: An example showing how to access a web service (Amazon.com) using Python.
• FlickrIntegration - One way of integrating flickr with Django
• GoogieSpell - Spell checking ​TextFields with ​GoogieSpell.

Tutorials on the web

• ​Django Blog: Notifying about new comments by email
• ​Extending Django's database API to include full-text search
• ​WordPress Clone in 27 Seconds
• ​Are you generic?
• ​Sending E-Mails via Templates
• ​Django admin for your PHP app?
• ​Hacking FreeComment
• ​The difference between blank and null
• ​Using Django’s TemplateTags
• ​A Django website that took (a lot) more than 20 minutes
• ​Forms With Multiple Inline Objects
• ​Extending Generic Views
• ​Template context processors
• ​Custom SQL In Django
• ​How Django processes a request
• ​Write better template tags
• ​Extending the User model
• ​Django’s Undocumented contenttype app
• ​Django, gzip and WSGI
• ​Django for non-programmers
• ​Django Templates: The Power of Inheritance
• ​Django Templates: An Introduction
• ​Setting up Django on Dreamhost
• ​Django on Windows HOWTO
• ​Django Admin Hack - Fields varying with user permissions
• ​Some django gotchas
• ​Django Templates are not limited
• ​Develop for the Web with Django and Python
• ​An AJAX Select Widget for Django
• ​Using Django’s Free Comments
• ​MochiKit and Django
• ​RSS made stupidly simple
• ​Installing Django on OSX

Presentations

• Snakes and Rubies Transcript: Currently a partial transcript of the Snakes and Rubies meeting videos.
• DjangoScreencasts: Official and unofficial screencasts showing Django development in action.
• ​Python Web development with Django: A presentation in pseudo-PowerPoint format that provides a good overview.

Resources in other languages

• Chinese Django Tutorial: A Chinese Django tutorial step by step. [Chinese]
• ​Jarosław Zabiełło Blog: Various Django tips and tutorials [Polish]
• ​Biblioteka Linuxa: Polish documentation and examples [Polish]
• ​French translation of Django documentation

Under discussion

• Model Inheritance: Subclassing and model inheritance.
• Version One features
• Localization (l10n)
• Streamlining Unicode Usage
• AJAX and Django
• Better Error Messages: Documenting situations where better error messages would improve the experience of developing with Django
• Multiple Database Support: Adding support for multiple database connections
• AutoEscaping: Auto escaping of variables by templates

Community

• Developers for hire: Community members available to do Django work.
• Django-friendly Web hosts
• ​Official Django badges
• ​Official Django logos
• DjangoUsers: User community about django.
• ​Pybots: Continuous integration testing of the Django development trunk against latest changes to the Python 2.5 maintenance branch and 2.6 development trunk.