| 1 |
==================== |
| 2 |
``contrib`` packages |
| 3 |
==================== |
| 4 |
|
| 5 |
Django aims to follow Python's :ref:`"batteries included" philosophy |
| 6 |
<tut-batteries-included>`. It ships with a variety of extra, optional tools |
| 7 |
that solve common web development problems. |
| 8 |
|
| 9 |
This code lives in :source:`django/contrib` in the Django distribution. This document |
| 10 |
gives a rundown of the packages in ``contrib``, along with any dependencies |
| 11 |
those packages have. |
| 12 |
|
| 13 |
.. admonition:: Including ``contrib`` packages in ``INSTALLED_APPS`` |
| 14 |
|
| 15 |
For most of these add-ons -- specifically, the add-ons that include either |
| 16 |
models or template tags -- you'll need to add the package name (e.g., |
| 17 |
``'django.contrib.redirects'``) to your :setting:`INSTALLED_APPS` setting |
| 18 |
and rerun ``manage.py migrate``. |
| 19 |
|
| 20 |
.. toctree:: |
| 21 |
:maxdepth: 1 |
| 22 |
|
| 23 |
admin/index |
| 24 |
auth |
| 25 |
contenttypes |
| 26 |
flatpages |
| 27 |
gis/index |
| 28 |
humanize |
| 29 |
messages |
| 30 |
postgres/index |
| 31 |
redirects |
| 32 |
sitemaps |
| 33 |
sites |
| 34 |
staticfiles |
| 35 |
syndication |
| 36 |
|
| 37 |
``admin`` |
| 38 |
========= |
| 39 |
|
| 40 |
The automatic Django administrative interface. For more information, see |
| 41 |
:doc:`Tutorial 2 </intro/tutorial02>` and the |
| 42 |
:doc:`admin documentation </ref/contrib/admin/index>`. |
| 43 |
|
| 44 |
Requires the auth_ and contenttypes_ contrib packages to be installed. |
| 45 |
|
| 46 |
``auth`` |
| 47 |
======== |
| 48 |
|
| 49 |
Django's authentication framework. |
| 50 |
|
| 51 |
See :doc:`/topics/auth/index`. |
| 52 |
|
| 53 |
``contenttypes`` |
| 54 |
================ |
| 55 |
|
| 56 |
A light framework for hooking into "types" of content, where each installed |
| 57 |
Django model is a separate content type. |
| 58 |
|
| 59 |
See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`. |
| 60 |
|
| 61 |
``flatpages`` |
| 62 |
============= |
| 63 |
|
| 64 |
A framework for managing "flat" HTML content in a database. |
| 65 |
|
| 66 |
See the :doc:`flatpages documentation </ref/contrib/flatpages>`. |
| 67 |
|
| 68 |
Requires the sites_ contrib package to be installed as well. |
| 69 |
|
| 70 |
``gis`` |
| 71 |
======= |
| 72 |
|
| 73 |
A world-class geospatial framework built on top of Django, that enables |
| 74 |
storage, manipulation and display of spatial data. |
| 75 |
|
| 76 |
See the :doc:`/ref/contrib/gis/index` documentation for more. |
| 77 |
|
| 78 |
``humanize`` |
| 79 |
============ |
| 80 |
|
| 81 |
A set of Django template filters useful for adding a "human touch" to data. |
| 82 |
|
| 83 |
See the :doc:`humanize documentation </ref/contrib/humanize>`. |
| 84 |
|
| 85 |
``messages`` |
| 86 |
============ |
| 87 |
|
| 88 |
A framework for storing and retrieving temporary cookie- or session-based |
| 89 |
messages |
| 90 |
|
| 91 |
See the :doc:`messages documentation </ref/contrib/messages>`. |
| 92 |
|
| 93 |
``postgres`` |
| 94 |
============ |
| 95 |
|
| 96 |
A collection of PostgreSQL specific features. |
| 97 |
|
| 98 |
See the :doc:`contrib.postgres documentation </ref/contrib/postgres/index>`. |
| 99 |
|
| 100 |
``redirects`` |
| 101 |
============= |
| 102 |
|
| 103 |
A framework for managing redirects. |
| 104 |
|
| 105 |
See the :doc:`redirects documentation </ref/contrib/redirects>`. |
| 106 |
|
| 107 |
``sessions`` |
| 108 |
============ |
| 109 |
|
| 110 |
A framework for storing data in anonymous sessions. |
| 111 |
|
| 112 |
See the :doc:`sessions documentation </topics/http/sessions>`. |
| 113 |
|
| 114 |
``sites`` |
| 115 |
========= |
| 116 |
|
| 117 |
A light framework that lets you operate multiple websites off of the same |
| 118 |
database and Django installation. It gives you hooks for associating objects to |
| 119 |
one or more sites. |
| 120 |
|
| 121 |
See the :doc:`sites documentation </ref/contrib/sites>`. |
| 122 |
|
| 123 |
``sitemaps`` |
| 124 |
============ |
| 125 |
|
| 126 |
A framework for generating Google sitemap XML files. |
| 127 |
|
| 128 |
See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`. |
| 129 |
|
| 130 |
``syndication`` |
| 131 |
=============== |
| 132 |
|
| 133 |
A framework for generating syndication feeds, in RSS and Atom, quite easily. |
| 134 |
|
| 135 |
See the :doc:`syndication documentation </ref/contrib/syndication>`. |