README.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. ===========
  2. django-nose
  3. ===========
  4. .. image:: https://img.shields.io/pypi/v/django-nose.svg
  5. :alt: The PyPI package
  6. :target: https://pypi.python.org/pypi/django-nose
  7. .. image:: https://img.shields.io/travis/django-nose/django-nose/master.svg
  8. :alt: TravisCI Build Status
  9. :target: https://travis-ci.org/django-nose/django-nose
  10. .. image:: https://img.shields.io/coveralls/django-nose/django-nose/master.svg
  11. :alt: Coveralls Test Coverage
  12. :target: https://coveralls.io/r/django-nose/django-nose?branch=master
  13. .. Omit badges from docs
  14. **django-nose** provides all the goodness of `nose`_ in your Django tests, like:
  15. * Testing just your apps by default, not all the standard ones that happen to
  16. be in ``INSTALLED_APPS``
  17. * Running the tests in one or more specific modules (or apps, or classes, or
  18. folders, or just running a specific test)
  19. * Obviating the need to import all your tests into ``tests/__init__.py``.
  20. This not only saves busy-work but also eliminates the possibility of
  21. accidentally shadowing test classes.
  22. * Taking advantage of all the useful `nose plugins`_
  23. .. _nose: https://nose.readthedocs.io/en/latest/
  24. .. _nose plugins: http://nose-plugins.jottit.com/
  25. It also provides:
  26. * Fixture bundling, an optional feature which speeds up your fixture-based
  27. tests by a factor of 4
  28. * Reuse of previously created test DBs, cutting 10 seconds off startup time
  29. * Hygienic TransactionTestCases, which can save you a DB flush per test
  30. * Support for various databases. Tested with MySQL, PostgreSQL, and SQLite.
  31. Others should work as well.
  32. django-nose requires nose 1.2.1 or later, and the `latest release`_ is
  33. recommended. It follows the `Django's support policy`_, supporting:
  34. * Django 1.8 (LTS) with Python 2.7, 3.4, or 3.5
  35. * Django 1.9 with Python 2.7, 3.4, or 3.5
  36. * Django 1.10 with Python 2.7, 3.4, or 3.5
  37. * Django 1.11 (LTS) with Python 2.7, 3.4, 3.5, or 3.6
  38. .. _latest release: https://pypi.python.org/pypi/nose
  39. .. _Django's support policy: https://docs.djangoproject.com/en/1.8/internals/release-process/#supported-versions
  40. Development
  41. -----------
  42. :Code: https://github.com/django-nose/django-nose
  43. :Issues: https://github.com/django-nose/django-nose/issues?state=open
  44. :Docs: https://django-nose.readthedocs.io