README.rst
1===================
2 Django Extensions
3===================
4
5.. image:: https://img.shields.io/pypi/l/django-extensions.svg
6 :target: https://raw.githubusercontent.com/django-extensions/django-extensions/master/LICENSE
7
8.. image:: https://secure.travis-ci.org/django-extensions/django-extensions.svg?branch=master
9 :alt: Build Status
10 :target: http://travis-ci.org/django-extensions/django-extensions
11
12.. image:: https://img.shields.io/pypi/v/django-extensions.svg
13 :target: https://pypi.python.org/pypi/django-extensions/
14 :alt: Latest PyPI version
15
16.. image:: https://img.shields.io/pypi/wheel/django-extensions.svg
17 :target: https://pypi.python.org/pypi/django-extensions/
18 :alt: Supports Wheel format
19
20.. image:: https://coveralls.io/repos/django-extensions/django-extensions/badge.svg?branch=master
21 :target: https://coveralls.io/r/django-extensions/django-extensions?branch=master
22 :alt: Coverage
23
24Django Extensions is a collection of custom extensions for the Django Framework.
25
26
27Getting Started
28===============
29
30The easiest way to figure out what Django Extensions are all about is to watch the
31`excellent screencast by Eric Holscher`__ (`watch the video on vimeo`__). In a couple
32minutes Eric walks you through a half a dozen command extensions. There is also a
33`short screencast on GoDjango's Youtube Channel`__ to help show you even more.
34
35
36Requirements
37============
38
39Django Extensions requires Django 2.2 or later.
40
41
42Getting It
43==========
44
45You can get Django Extensions by using pip::
46
47 $ pip install django-extensions
48
49If you want to install it from source, grab the git repository from GitHub and run setup.py::
50
51 $ git clone git://github.com/django-extensions/django-extensions.git
52 $ cd django-extensions
53 $ python setup.py install
54
55
56Installing It
57=============
58
59To enable `django_extensions` in your project you need to add it to `INSTALLED_APPS` in your projects
60`settings.py` file::
61
62 INSTALLED_APPS = (
63 ...
64 'django_extensions',
65 ...
66 )
67
68
69Using It
70========
71
72Generate (and view) a graphviz graph of app models::
73
74 $ python manage.py graph_models -a -o myapp_models.png
75
76Produce a tab-separated list of `(url_pattern, view_function, name)` tuples for a project::
77
78 $ python manage.py show_urls
79
80Check templates for rendering errors::
81
82 $ python manage.py validate_templates
83
84Run the enhanced django shell::
85
86 $ python manage.py shell_plus
87
88Run the enhanced django runserver, (requires Werkzeug install)::
89
90 $ python manage.py runserver_plus
91
92
93Getting Involved
94================
95
96Open Source projects can always use more help. Fixing a problem, documenting a feature, adding
97translation in your language. If you have some time to spare and like to help us, here are the places to do so:
98
99- GitHub: https://github.com/django-extensions/django-extensions
100- Mailing list: http://groups.google.com/group/django-extensions
101- Translations: https://www.transifex.net/projects/p/django-extensions/
102
103
104Documentation
105=============
106
107You can view documentation online at:
108
109- https://django-extensions.readthedocs.io
110
111Or you can look at the docs/ directory in the repository.
112
113
114Support
115=======
116
117Django Extensions is free and always will be. It is development and maintained by developers in an Open Source manner.
118Any support is welcome. You could help by writing documentation, pull-requests, report issues and/or translations.
119
120Please remember that nobody is paid directly to develop or maintain Django Extensions so we do have to divide our time
121between putting food on the table, family, this project and the rest of life :-)
122
123
124__ http://ericholscher.com/blog/2008/sep/12/screencast-django-command-extensions/
125__ http://vimeo.com/1720508
126__ https://www.youtube.com/watch?v=1F6G3ONhr4k
127
