DESCRIPTION.rst 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. image:: https://secure.travis-ci.org/pytest-dev/pytest-django.png?branch=master
  2. :alt: Build Status
  3. :target: https://travis-ci.org/pytest-dev/pytest-django
  4. Welcome to pytest-django!
  5. =========================
  6. pytest-django allows you to test your Django project/applications with the
  7. `pytest testing tool <http://pytest.org/>`_.
  8. * `Quick start / tutorial
  9. <https://pytest-django.readthedocs.io/en/latest/tutorial.html>`_
  10. * `Changelog <https://pytest-django.readthedocs.io/en/latest/changelog.html>`_
  11. * Full documentation: https://pytest-django.readthedocs.io/en/latest/
  12. * `Contribution docs
  13. <https://pytest-django.readthedocs.io/en/latest/contributing.html>`_
  14. * Version compatibility:
  15. * Django: 1.7-1.10 and latest master branch (compatible at the time of each release)
  16. * Python: CPython 2.7,3.3-3.5 or PyPy 2,3
  17. * pytest: >2.9.x
  18. * Licence: BSD
  19. * Project maintainers: Andreas Pelme, Floris Bruynooghe and Daniel Hahler
  20. * `All contributors <https://github.com/pytest-dev/pytest-django/contributors>`_
  21. * Github repository: https://github.com/pytest-dev/pytest-django
  22. * `Issue tracker <http://github.com/pytest-dev/pytest-django/issues>`_
  23. * `Python Package Index (PyPI) <https://pypi.python.org/pypi/pytest-django/>`_
  24. Install pytest-django
  25. ---------------------
  26. ::
  27. pip install pytest-django
  28. Why would I use this instead of Django's `manage.py test` command?
  29. ------------------------------------------------------------------
  30. Running your test suite with pytest-django allows you to tap into the features
  31. that are already present in pytest. Here are some advantages:
  32. * `Manage test dependencies with pytest fixtures. <http://pytest.org/latest/fixture.html>`_
  33. * Less boilerplate tests: no need to import unittest, create a subclass with methods. Write tests as regular functions.
  34. * Database re-use: no need to re-create the test database for every test run.
  35. * Run tests in multiple processes for increased speed (with the pytest-xdist plugin).
  36. * Make use of other `pytest plugins <http://pytest.org/latest/plugins.html>`_.
  37. * Works with both worlds: Existing unittest-style TestCase's still work without any modifications.
  38. See the `pytest documentation <http://pytest.org/latest/>`_ for more information on pytest itself.