Go to file
Florian Bruhin 7d150c20cf Regenerate 2.8.5 docs. 2015-12-11 22:28:23 -02:00
_pytest Prepare for 2.8.5: bump version, CHANGELOG, announce 2015-12-11 19:20:07 -02:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Regenerate 2.8.5 docs. 2015-12-11 22:28:23 -02:00
extra another update for get_issues.py to account for repository move 2015-02-27 09:12:00 -05:00
testing added docstrign to inection collection test. 2015-12-10 15:19:08 -08: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 Update travis with new tox environments 2015-09-26 03:43:37 -03:00
AUTHORS added myself to authors, added changelog entry. 2015-12-10 15:15:09 -08:00
CHANGELOG Prepare for 2.8.5: bump version, CHANGELOG, announce 2015-12-11 19:20:07 -02:00
CONTRIBUTING.rst Update CONTRIBUTING.rst 2015-10-24 02:21:22 -07:00
HOWTORELEASE.rst add a reminder of the features branch merge to HOWTORELEASE.rst 2015-12-09 21:20:54 +01:00
ISSUES.txt Fix spelling: explicitely --> explicitly 2015-12-01 01:41:47 -08:00
LICENSE * use the MIT license for the py lib 2009-10-03 01:11:04 +02:00
MANIFEST.in adopt review comment of #1186 2015-12-06 10:24:24 +01:00
README.rst Use https for images in readme 2015-12-09 18:01:36 -05:00
appveyor.yml Optimize appveyor build 2015-12-11 00:20:20 -02: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 Use py35 as preferred py3 interpreter for special test environments 2015-09-26 03:37:21 -03:00

README.rst

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

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

.. image:: https://img.shields.io/pypi/v/pytest.svg
   :target: https://pypi.python.org/pypi/pytest
.. image:: https://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.