django-extras / docs / index.txt

.. _index:

===========================
Django Extras documentation
===========================

Project Status
==============

This is a fairly new project, while this package is utilised in production on
several projects the status will remain as beta until unit-test coverage has
been expanded. Documentation is now fairly complete, in general areas of the
code base that have not been documented should be considered unstable.

Getting help
============

* Report bugs with Django Extras with the `issue tracker`_.

.. _issue tracker: https://bitbucket.org/timsavage/django-extras/issues

What's in Django Extras
=======================

Django Extras is a project that provides extensions for Django_ to solve common
development situations not (or not yet) covered by the core Django framework.

Examples of this include:

* additional decorators
* model mixins to easily assign owners to a model
* additional model and form fields
* greatly expanded collection of default response classes

See :doc:`ref/index` full reference.

First steps
===========

If you are new to Django it is recommended you visit the `Django documentation`_
as they have excellent documentation to get you up and running.

.. _Django: https://www.djangoproject.com/
.. _Django documentation: https://docs.djangoproject.com/

Other batteries included
========================

* :doc:`Authentication <topics/auth>`

Source code
===========

Full `source code`_ is available in Bit Bucket.

.. _source code: https://bitbucket.org/timsavage/django-extras/src
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.