README.rst 3.7 KB

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