index.txt 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. ====================
  2. ``contrib`` packages
  3. ====================
  4. Django aims to follow Python's `"batteries included" philosophy`_. It ships
  5. with a variety of extra, optional tools that solve common Web-development
  6. problems.
  7. This code lives in ``django/contrib`` in the Django distribution. This document
  8. gives a rundown of the packages in ``contrib``, along with any dependencies
  9. those packages have.
  10. .. admonition:: Note
  11. For most of these add-ons -- specifically, the add-ons that include either
  12. models or template tags -- you'll need to add the package name (e.g.,
  13. ``'django.contrib.redirects'``) to your :setting:`INSTALLED_APPS` setting
  14. and re-run ``manage.py migrate``.
  15. .. _"batteries included" philosophy: https://docs.python.org/tutorial/stdlib.html#batteries-included
  16. .. toctree::
  17. :maxdepth: 1
  18. admin/index
  19. auth
  20. contenttypes
  21. flatpages
  22. gis/index
  23. humanize
  24. messages
  25. postgres/index
  26. redirects
  27. sitemaps
  28. sites
  29. staticfiles
  30. syndication
  31. admin
  32. =====
  33. The automatic Django administrative interface. For more information, see
  34. :doc:`Tutorial 2 </intro/tutorial02>` and the
  35. :doc:`admin documentation </ref/contrib/admin/index>`.
  36. Requires the auth_ and contenttypes_ contrib packages to be installed.
  37. auth
  38. ====
  39. Django's authentication framework.
  40. See :doc:`/topics/auth/index`.
  41. contenttypes
  42. ============
  43. A light framework for hooking into "types" of content, where each installed
  44. Django model is a separate content type.
  45. See the :doc:`contenttypes documentation </ref/contrib/contenttypes>`.
  46. flatpages
  47. =========
  48. A framework for managing simple "flat" HTML content in a database.
  49. See the :doc:`flatpages documentation </ref/contrib/flatpages>`.
  50. Requires the sites_ contrib package to be installed as well.
  51. gis
  52. ====
  53. A world-class geospatial framework built on top of Django, that enables
  54. storage, manipulation and display of spatial data.
  55. See the :doc:`/ref/contrib/gis/index` documentation for more.
  56. humanize
  57. ========
  58. A set of Django template filters useful for adding a "human touch" to data.
  59. See the :doc:`humanize documentation </ref/contrib/humanize>`.
  60. messages
  61. ========
  62. A framework for storing and retrieving temporary cookie- or session-based
  63. messages
  64. See the :doc:`messages documentation </ref/contrib/messages>`.
  65. postgres
  66. ========
  67. A collection of PostgreSQL specific features.
  68. See the :doc:`contrib.postgres documentation </ref/contrib/postgres/index>`.
  69. redirects
  70. =========
  71. A framework for managing redirects.
  72. See the :doc:`redirects documentation </ref/contrib/redirects>`.
  73. sessions
  74. ========
  75. A framework for storing data in anonymous sessions.
  76. See the :doc:`sessions documentation </topics/http/sessions>`.
  77. sites
  78. =====
  79. A light framework that lets you operate multiple Web sites off of the same
  80. database and Django installation. It gives you hooks for associating objects to
  81. one or more sites.
  82. See the :doc:`sites documentation </ref/contrib/sites>`.
  83. sitemaps
  84. ========
  85. A framework for generating Google sitemap XML files.
  86. See the :doc:`sitemaps documentation </ref/contrib/sitemaps>`.
  87. syndication
  88. ===========
  89. A framework for generating syndication feeds, in RSS and Atom, quite easily.
  90. See the :doc:`syndication documentation </ref/contrib/syndication>`.
  91. Other add-ons
  92. =============
  93. If you have an idea for functionality to include in ``contrib``, let us know!
  94. Code it up, and post it to the |django-users| mailing list.