BertrandBordage / django-extensions

This is a repository for collecting global custom management extensions for the Django Framework.

Django Extensions

Django Extensions is a collection of custom extensions for the Django Framework.

Getting Started

The easiest way to figure out what Django Extensions are all about is to watch the excellent screencast by Eric Holscher (watch the video on vimeo). In a couple minutes Eric walks you through a half a dozen command extensions. There is also a short screencast on GoDjango to help show you even more.

Requirements

Django Extensions requires Django 1.4 or later.

Getting It

You can get Django Extensions by using pip or easy_install:

$ pip install django-extensions
or
$ easy_install django-extensions

If you want to install it from source, grab the git repository from GitHub and run setup.py:

$ git clone git://github.com/django-extensions/django-extensions.git
$ cd django-extensions
$ python setup.py install

Installing It

To enable django_extensions in your project you need to add it to INSTALLED_APPS in your projects settings.py file:

INSTALLED_APPS = (
    ...
    'django_extensions',
    ...
)

Using It

Generate (and view) a graphviz graph of app models:

$ python manage.py graph_models -a -o myapp_models.png

Produce a tab-separated list of (url_pattern, view_function, name) tuples for a project:

$ python manage.py show_urls

Check templates for rendering errors:

$ python manage.py validate_templates

Run the enchanced django shell:

$ python manage.py shell_plus

Run the enchanced django runserver, (requires Werkzeug install):

$ python manage.py runserver_plus

Getting Involved

Open Source projects can always use more help. Fixing a problem, documenting a feature, adding translation in your language. If you have some time to spare and like to help us, here are the places to do so:

• GitHub: https://github.com/django-extensions/django-extensions
• Mailing list: http://groups.google.com/group/django-extensions
• Translations: https://www.transifex.net/projects/p/django-extensions/

Documentation

You can view documentation online at:

• http://django-extensions.readthedocs.org

Or you can look at the docs/ directory in the repository.

Donations

Django Extensions is free and always will be. From time to time people and company's have expressed the willingness to donation to the project to help foster it's development. We prefer people to become active in the project and support us by sending pull requests but will humbly accept donations as well.

Donations will be used to make Django Extensions better by allowing developers to spend more time on it, paying to go to conferences, paying for infrastructure, etc. If for some reason we would receive more donations then needed they will go towards the Django and Python foundations.

We have setup a couple of ways you can donate towards Django Extensions using the buttons below:

• Bountysource
• Bitcoins at address: 13V3AaapCRz2i2HnJiFoqVECe1t5H26yCg
• Gratipay (formerly Gittip)
• Flattr
• PayPal
• Patreon here