README.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. ===================
  2. Django Extensions
  3. ===================
  4. .. image:: https://img.shields.io/badge/license-MIT-blue.svg
  5. :target: https://raw.githubusercontent.com/django-extensions/django-extensions/master/LICENSE
  6. .. image:: https://secure.travis-ci.org/django-extensions/django-extensions.png?branch=master
  7. :alt: Build Status
  8. :target: http://travis-ci.org/django-extensions/django-extensions
  9. .. image:: https://pypip.in/v/django-extensions/badge.png
  10. :target: https://pypi.python.org/pypi/django-extensions/
  11. :alt: Latest PyPI version
  12. .. image:: https://pypip.in/d/django-extensions/badge.png
  13. :target: https://pypi.python.org/pypi/django-extensions/
  14. :alt: Number of PyPI downloads
  15. Django Extensions is a collection of custom extensions for the Django Framework.
  16. Getting Started
  17. ===============
  18. The easiest way to figure out what Django Extensions are all about is to watch the
  19. `excellent screencast by Eric Holscher`__ (`watch the video on vimeo`__). In a couple
  20. minutes Eric walks you through a half a dozen command extensions. There is also a
  21. `short screencast on GoDjango`__ to help show you even more.
  22. Requirements
  23. ============
  24. Django Extensions requires Django 1.4 or later.
  25. Getting It
  26. ==========
  27. You can get Django Extensions by using pip or easy_install::
  28. $ pip install django-extensions
  29. or
  30. $ easy_install django-extensions
  31. If you want to install it from source, grab the git repository from GitHub and run setup.py::
  32. $ git clone git://github.com/django-extensions/django-extensions.git
  33. $ cd django-extensions
  34. $ python setup.py install
  35. Installing It
  36. =============
  37. To enable `django_extensions` in your project you need to add it to `INSTALLED_APPS` in your projects
  38. `settings.py` file::
  39. INSTALLED_APPS = (
  40. ...
  41. 'django_extensions',
  42. ...
  43. )
  44. Using It
  45. ========
  46. Generate (and view) a graphviz graph of app models::
  47. $ python manage.py graph_models -a -o myapp_models.png
  48. Produce a tab-separated list of `(url_pattern, view_function, name)` tuples for a project::
  49. $ python manage.py show_urls
  50. Check templates for rendering errors::
  51. $ python manage.py validate_templates
  52. Run the enchanced django shell::
  53. $ python manage.py shell_plus
  54. Run the enchanced django runserver, (requires Werkzeug install)::
  55. $ python manage.py runserver_plus
  56. Getting Involved
  57. ================
  58. Open Source projects can always use more help. Fixing a problem, documenting a feature, adding
  59. translation in your language. If you have some time to spare and like to help us, here are the places to do so:
  60. - GitHub: https://github.com/django-extensions/django-extensions
  61. - Mailing list: http://groups.google.com/group/django-extensions
  62. - Translations: https://www.transifex.net/projects/p/django-extensions/
  63. Documentation
  64. =============
  65. You can view documentation online at:
  66. - http://django-extensions.readthedocs.org
  67. Or you can look at the docs/ directory in the repository.
  68. Donations
  69. =========
  70. Django Extensions is free and always will be. From time to time people and company's have expressed the willingness
  71. to donation to the project to help foster it's development. We prefer people to become active in the project and support
  72. us by sending pull requests but will humbly accept donations as well.
  73. Donations will be used to make Django Extensions better by allowing developers to spend more time on it, paying to go
  74. to conferences, paying for infrastructure, etc. If for some reason we would receive more donations then needed they will
  75. go towards the Django and Python foundations.
  76. We have setup a couple of ways you can donate towards Django Extensions using the buttons below:
  77. - Bountysource
  78. - Bitcoins at address: 13V3AaapCRz2i2HnJiFoqVECe1t5H26yCg
  79. - Gratipay (formerly Gittip)
  80. - Flattr
  81. - PayPal
  82. - Patreon `here <https://patreon.com/trbs>`_
  83. .. image:: https://www.bountysource.com/badge/team?team_id=7470&style=bounties_posted
  84. :target: https://www.bountysource.com/teams/django-extensions/bounties?utm_source=django-extensions&utm_medium=shield&utm_campaign=bounties_posted
  85. :alt: BountySource
  86. .. image:: https://img.shields.io/bitcoin/donate.png
  87. :target: bitcoin:13V3AaapCRz2i2HnJiFoqVECe1t5H26yCg?label=DjangoExtensions
  88. .. image:: https://img.shields.io/flattr/donate.png
  89. :target: https://flattr.com/submit/auto?user_id=Trbs&url=https%3A%2F%2Fgithub.com%2Fdjango-extensions%2Fdjango-extensions
  90. :alt: Flattr this
  91. .. image:: https://img.shields.io/paypal/donate.png
  92. :target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=P57EJJ9QYL232
  93. :alt: PayPal Donations
  94. .. image:: https://img.shields.io/gratipay/trbs.png
  95. :target: https://gratipay.com/trbs/
  96. :alt: Gifts received
  97. __ http://ericholscher.com/blog/2008/sep/12/screencast-django-command-extensions/
  98. __ http://vimeo.com/1720508
  99. __ https://godjango.com/39-be-more-productive-with-django_extensions/