summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-07-01 13:58:04 -0400
committerTim Graham <timograham@gmail.com>2013-07-10 11:32:28 -0400
commit13546cae9c7922088266c32a5be2bda77545a04b (patch)
tree08f53d0f36b3eda884ca5f0de93d23d8a5ae5850 /docs/internals/contributing/writing-code
parent7bbf6971329d7fdd5343895c7e8c292f7e64d95e (diff)
[1.5.x] Fixed #19196 -- Added test/requirements
Backport of 4d92a0bd86 from master.
Diffstat (limited to 'docs/internals/contributing/writing-code')
-rw-r--r--docs/internals/contributing/writing-code/unit-tests.txt19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt
index 4a436de795..aac59bc2a0 100644
--- a/docs/internals/contributing/writing-code/unit-tests.txt
+++ b/docs/internals/contributing/writing-code/unit-tests.txt
@@ -138,29 +138,46 @@ Running all the tests
If you want to run the full suite of tests, you'll need to install a number of
dependencies:
+* PIL_
* PyYAML_
* Markdown_
* Textile_
* Docutils_
+* pytz_
* setuptools_
* memcached_, plus a :ref:`supported Python binding <memcached>`
* gettext_ (:ref:`gettext_on_windows`)
-* selenium_ (if also using Python >= 2.6)
+* selenium_
+
+You can find these dependencies in `pip requirements files`_ inside the
+``tests/requirements`` directory of the Django source tree and install them
+like so::
+
+ pip install -r tests/requirements/py2.txt # Python 3: py3.txt
+
+You can also install the database adapter(s) of your choice using
+``oracle.txt``, ``mysql.txt``, or ``postgres.txt``.
If you want to test the memcached cache backend, you'll also need to define
a :setting:`CACHES` setting that points at your memcached instance.
+To run the GeoDjango tests, you will need to :doc:`setup a spatial database
+and install the Geospatial libraries</ref/contrib/gis/install/index>`.
+
Each of these dependencies is optional. If you're missing any of them, the
associated tests will be skipped.
+.. _PIL: https://pypi.python.org/pypi/PIL
.. _PyYAML: http://pyyaml.org/wiki/PyYAML
.. _Markdown: http://pypi.python.org/pypi/Markdown/1.7
.. _Textile: http://pypi.python.org/pypi/textile
.. _docutils: http://pypi.python.org/pypi/docutils/0.4
+.. _pytz: https://pypi.python.org/pypi/pytz/
.. _setuptools: http://pypi.python.org/pypi/setuptools/
.. _memcached: http://memcached.org/
.. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html
.. _selenium: http://pypi.python.org/pypi/selenium
+.. _pip requirements files: http://www.pip-installer.org/en/latest/requirements.html
Code coverage
~~~~~~~~~~~~~