2009-12-26 03:44:21 +00:00
|
|
|
====================
|
|
|
|
|
``contrib`` packages
|
|
|
|
|
====================
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2006-08-01 20:48:26 +00:00
|
|
|
Django aims to follow Python's `"batteries included" philosophy`_. It ships
|
|
|
|
|
with a variety of extra, optional tools that solve common Web-development
|
|
|
|
|
problems.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2007-06-07 17:50:53 +00:00
|
|
|
This code lives in ``django/contrib`` in the Django distribution. This document
|
2007-06-07 21:41:41 +00:00
|
|
|
gives a rundown of the packages in ``contrib``, along with any dependencies
|
2007-06-07 17:50:53 +00:00
|
|
|
those packages have.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2007-03-27 22:18:52 +00:00
|
|
|
.. admonition:: Note
|
|
|
|
|
|
|
|
|
|
For most of these add-ons -- specifically, the add-ons that include either
|
|
|
|
|
models or template tags -- you'll need to add the package name (e.g.,
|
2011-05-29 17:41:04 +00:00
|
|
|
``'django.contrib.admin'``) to your :setting:`INSTALLED_APPS` setting and
|
|
|
|
|
re-run ``manage.py syncdb``.
|
2007-03-27 22:18:52 +00:00
|
|
|
|
2009-12-26 06:37:26 +00:00
|
|
|
.. _"batteries included" philosophy: http://docs.python.org/tutorial/stdlib.html#batteries-included
|
2006-08-01 20:48:26 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2009-03-23 20:22:56 +00:00
|
|
|
admin/index
|
2008-08-23 22:25:40 +00:00
|
|
|
auth
|
2008-08-25 22:14:22 +00:00
|
|
|
comments/index
|
2008-08-23 22:25:40 +00:00
|
|
|
contenttypes
|
|
|
|
|
csrf
|
|
|
|
|
databrowse
|
|
|
|
|
flatpages
|
|
|
|
|
formtools/index
|
2010-03-26 20:14:53 +00:00
|
|
|
gis/index
|
2008-08-23 22:25:40 +00:00
|
|
|
humanize
|
|
|
|
|
localflavor
|
2010-08-28 02:40:17 +00:00
|
|
|
markup
|
2009-12-09 16:57:23 +00:00
|
|
|
messages
|
2008-08-23 22:25:40 +00:00
|
|
|
redirects
|
|
|
|
|
sitemaps
|
|
|
|
|
sites
|
2010-10-20 01:33:24 +00:00
|
|
|
staticfiles
|
2008-08-23 22:25:40 +00:00
|
|
|
syndication
|
|
|
|
|
webdesign
|
|
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
admin
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
The automatic Django administrative interface. For more information, see
|
2010-08-19 19:27:44 +00:00
|
|
|
:doc:`Tutorial 2 </intro/tutorial02>` and the
|
|
|
|
|
:doc:`admin documentation </ref/contrib/admin/index>`.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2007-06-07 17:50:53 +00:00
|
|
|
Requires the auth_ and contenttypes_ contrib packages to be installed.
|
|
|
|
|
|
2006-05-22 03:14:33 +00:00
|
|
|
auth
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
Django's authentication framework.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See :doc:`/topics/auth`.
|
2006-05-22 03:14:33 +00:00
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
comments
|
|
|
|
|
========
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
A simple yet flexible comments system. See :doc:`/ref/contrib/comments/index`.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2006-05-22 03:14:33 +00:00
|
|
|
contenttypes
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
A light framework for hooking into "types" of content, where each installed
|
2007-12-17 07:39:24 +00:00
|
|
|
Django model is a separate content type.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
|
2006-05-22 03:14:33 +00:00
|
|
|
|
|
|
|
|
csrf
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
A middleware for preventing Cross Site Request Forgeries
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`csrf documentation </ref/contrib/csrf>`.
|
2006-05-22 03:14:33 +00:00
|
|
|
|
2007-12-01 17:07:32 +00:00
|
|
|
flatpages
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
A framework for managing simple "flat" HTML content in a database.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
|
2007-12-01 17:07:32 +00:00
|
|
|
|
|
|
|
|
Requires the sites_ contrib package to be installed as well.
|
|
|
|
|
|
2006-12-05 20:51:25 +00:00
|
|
|
formtools
|
|
|
|
|
=========
|
|
|
|
|
|
2008-07-21 16:38:54 +00:00
|
|
|
A set of high-level abstractions for Django forms (django.forms).
|
2006-12-05 20:51:25 +00:00
|
|
|
|
|
|
|
|
django.contrib.formtools.preview
|
|
|
|
|
--------------------------------
|
|
|
|
|
|
|
|
|
|
An abstraction of the following workflow:
|
|
|
|
|
|
|
|
|
|
"Display an HTML form, force a preview, then do something with the submission."
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`form preview documentation </ref/contrib/formtools/form-preview>`.
|
2008-08-23 22:25:40 +00:00
|
|
|
|
|
|
|
|
django.contrib.formtools.wizard
|
2011-08-13 13:51:34 +00:00
|
|
|
-------------------------------
|
2007-09-14 23:15:40 +00:00
|
|
|
|
2008-08-23 22:25:40 +00:00
|
|
|
Splits forms across multiple Web pages.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`form wizard documentation </ref/contrib/formtools/form-wizard>`.
|
2006-12-05 20:51:25 +00:00
|
|
|
|
2010-03-26 20:14:53 +00:00
|
|
|
gis
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
A world-class geospatial framework built on top of Django, that enables
|
|
|
|
|
storage, manipulation and display of spatial data.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`/ref/contrib/gis/index` documentation for more.
|
2010-03-26 20:14:53 +00:00
|
|
|
|
2006-06-04 00:58:39 +00:00
|
|
|
humanize
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
A set of Django template filters useful for adding a "human touch" to data.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`humanize documentation </ref/contrib/humanize>`.
|
2007-08-20 08:50:08 +00:00
|
|
|
|
2007-02-15 05:53:44 +00:00
|
|
|
localflavor
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
A collection of various Django snippets that are useful only for a particular
|
2007-12-17 08:58:29 +00:00
|
|
|
country or culture. For example, ``django.contrib.localflavor.us.forms``
|
2007-02-15 05:53:44 +00:00
|
|
|
contains a ``USZipCodeField`` that you can use to validate U.S. zip codes.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`localflavor documentation </ref/contrib/localflavor>`.
|
2007-12-17 08:58:29 +00:00
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
markup
|
|
|
|
|
======
|
|
|
|
|
|
2010-08-28 02:40:17 +00:00
|
|
|
A collection of template filters that implement common markup languages
|
2010-05-09 04:49:11 +00:00
|
|
|
|
2010-08-28 02:40:17 +00:00
|
|
|
See the :doc:`markup documentation </ref/contrib/markup>`.
|
2010-05-09 04:49:11 +00:00
|
|
|
|
2009-12-09 16:57:23 +00:00
|
|
|
messages
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. versionchanged:: 1.2
|
|
|
|
|
The messages framework was added.
|
|
|
|
|
|
|
|
|
|
A framework for storing and retrieving temporary cookie- or session-based
|
|
|
|
|
messages
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`messages documentation </ref/contrib/messages>`.
|
2009-12-09 16:57:23 +00:00
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
redirects
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
A framework for managing redirects.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`redirects documentation </ref/contrib/redirects>`.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2007-12-01 17:07:32 +00:00
|
|
|
sessions
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
A framework for storing data in anonymous sessions.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`sessions documentation </topics/http/sessions>`.
|
2007-12-01 17:07:32 +00:00
|
|
|
|
2006-05-22 03:14:33 +00:00
|
|
|
sites
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
A light framework that lets you operate multiple Web sites off of the same
|
|
|
|
|
database and Django installation. It gives you hooks for associating objects to
|
2006-05-22 04:48:44 +00:00
|
|
|
one or more sites.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`sites documentation </ref/contrib/sites>`.
|
2006-05-22 03:14:33 +00:00
|
|
|
|
2006-08-31 23:19:53 +00:00
|
|
|
sitemaps
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
A framework for generating Google sitemap XML files.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
|
2006-08-31 23:19:53 +00:00
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
syndication
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
A framework for generating syndication feeds, in RSS and Atom, quite easily.
|
|
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`syndication documentation </ref/contrib/syndication>`.
|
2005-11-22 19:21:51 +00:00
|
|
|
|
2007-12-01 17:07:32 +00:00
|
|
|
webdesign
|
|
|
|
|
=========
|
|
|
|
|
|
2008-08-10 18:17:20 +00:00
|
|
|
Helpers and utilities targeted primarily at Web *designers* rather than
|
2007-12-04 06:05:28 +00:00
|
|
|
Web *developers*.
|
2007-12-01 17:07:32 +00:00
|
|
|
|
2010-08-19 19:27:44 +00:00
|
|
|
See the :doc:`Web design helpers documentation </ref/contrib/webdesign>`.
|
2007-12-01 17:07:32 +00:00
|
|
|
|
2005-11-22 19:21:51 +00:00
|
|
|
Other add-ons
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
If you have an idea for functionality to include in ``contrib``, let us know!
|
|
|
|
|
Code it up, and post it to the `django-users mailing list`_.
|
|
|
|
|
|
|
|
|
|
.. _django-users mailing list: http://groups.google.com/group/django-users
|
