Go to file
Oleg Alexandrov 9d2d2d17af Clarify documentation
Fix doc markup
2015-09-25 21:46:06 -07:00
_pytest Merge pull request #1031 from pytest-dev/unmarshable-parametrize 2015-09-23 09:03:51 +02:00
appveyor Remove unused run_with_env script 2015-09-14 11:28:07 -03:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Clarify documentation 2015-09-25 21:46:06 -07:00
extra another update for get_issues.py to account for repository move 2015-02-27 09:12:00 -05:00
testing escape bytes when creating ids for parametrized values 2015-09-22 23:18:09 -03:00
.coveragerc Ignore vendored_packages folder for coverage purposes 2015-09-14 10:30:58 -03:00
.gitattributes Use "union" merge strategy for CHANGELOG 2015-08-10 19:27:22 -03:00
.gitignore revert setuptools_scm addition introduced with f22d14b105 2015-09-17 12:58:04 +02:00
.travis.yml Use python "3.5" on travis 2015-09-14 10:36:20 -03:00
AUTHORS update changelog/author info, bump version number 2015-09-17 13:43:39 +02:00
CHANGELOG Merge pull request #1056 from icemac/patch-1 2015-09-23 09:10:20 +02:00
CONTRIBUTING.rst Fix git checkout command in CONTRIBUTING.rst 2015-09-22 10:54:37 -03:00
HOWTORELEASE.rst Small format fixes in HOWTORELEASE 2015-09-25 23:10:35 -03:00
ISSUES.txt fix some spelling mistakes 2014-10-13 23:16:26 +01:00
LICENSE * use the MIT license for the py lib 2009-10-03 01:11:04 +02:00
MANIFEST.in fix manifest 2013-08-15 13:05:01 +02:00
README.rst Various Python 3.5 documentation mentions 2015-09-17 07:32:52 -04:00
appveyor.yml Remove unused run_with_env script 2015-09-14 11:28:07 -03:00
plugin-test.sh add pluginmanager.do_configure(config) as a link to 2013-10-04 11:36:45 +02:00
pytest.py revert setuptools_scm addition introduced with f22d14b105 2015-09-17 12:58:04 +02:00
requirements-docs.txt use regendoc normalization and regenerate docs 2015-06-06 23:30:49 +02:00
runtox.py make runtox.py not import external modules unless run as a script 2014-04-05 08:51:00 +02:00
setup.cfg configure a plain "devpi upload" to create sdist and universal wheel 2015-07-09 14:56:56 +02:00
setup.py Merge pull request #1019 from mdboom/python3.5-docs 2015-09-17 13:45:35 +02:00
tox.ini generate docs on python3.4 2015-09-22 16:52:35 +02:00

README.rst

======
pytest
======

The ``pytest`` testing tool makes it easy to write small tests, yet
scales to support complex functional testing.

.. image:: http://img.shields.io/pypi/v/pytest.svg
   :target: https://pypi.python.org/pypi/pytest
.. image:: http://img.shields.io/coveralls/pytest-dev/pytest/master.svg
   :target: https://coveralls.io/r/pytest-dev/pytest
.. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master
    :target: https://travis-ci.org/pytest-dev/pytest
.. image:: https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true
    :target: https://ci.appveyor.com/project/pytestbot/pytest

Documentation: http://pytest.org/latest/

Changelog: http://pytest.org/latest/changelog.html

Issues: https://github.com/pytest-dev/pytest/issues

Features
--------

- `auto-discovery
  <http://pytest.org/latest/goodpractises.html#python-test-discovery>`_
  of test modules and functions,
- detailed info on failing `assert statements <http://pytest.org/latest/assert.html>`_ (no need to remember ``self.assert*`` names)
- `modular fixtures <http://pytest.org/latest/fixture.html>`_  for
  managing small or parametrized long-lived test resources.
- multi-paradigm support: you can use ``pytest`` to run test suites based
  on `unittest <http://pytest.org/latest/unittest.html>`_ (or trial),
  `nose <http://pytest.org/latest/nose.html>`_
- single-source compatibility from Python2.6 all the way up to
  Python3.5, PyPy-2.3, (jython-2.5 untested)


- many `external plugins <http://pytest.org/latest/plugins.html#installing-external-plugins-searching>`_.

A simple example for a test:

.. code-block:: python

    # content of test_module.py
    def test_function():
        i = 4
        assert i == 3

which can be run with ``py.test test_module.py``.  See `getting-started <http://pytest.org/latest/getting-started.html#our-first-test-run>`_ for more examples.

For much more info, including PDF docs, see

    http://pytest.org

and report bugs at:

    https://github.com/pytest-dev/pytest/issues

and checkout or fork repo at:

    https://github.com/pytest-dev/pytest


Copyright Holger Krekel and others, 2004-2015
Licensed under the MIT license.