Go to file
Bruno Oliveira 0ff7f5d0c6 Prepare CHANGELOG for version 3.1.0 2017-05-19 19:10:09 -03:00
.github Mention small doc fixes don't need tests/changelog entries in PR template 2016-10-05 15:36:38 -03:00
_pytest Revert refactor of old-style to new-style classes 2017-05-17 18:20:51 -03:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Merge remote-tracking branch 'upstream/master' into features 2017-05-19 18:01:56 -04:00
extra Adapt get_issues.py script for GitHub (instead of Bitbucket) 2016-03-28 20:00:57 +02:00
scripts restore check-manifst functionality 2017-04-19 20:12:38 +02:00
tasks Implement tasks to improve release automation 2017-05-15 23:44:03 -03:00
testing Improve tests a bit 2017-05-12 17:52:50 -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 second take at setuptools_scm 2017-04-19 19:40:42 +02:00
.travis.yml Test against py36 official release for consistency with other python versions 2017-04-13 17:54:56 -03:00
AUTHORS Update AUTHORS list 2017-05-12 17:48:50 -03:00
CHANGELOG.rst Prepare CHANGELOG for version 3.1.0 2017-05-19 19:10:09 -03:00
CONTRIBUTING.rst Recommend using py36 for testing on CONTRIBUTING 2017-03-16 22:20:38 -03:00
HOWTORELEASE.rst Implement tasks to improve release automation 2017-05-15 23:44:03 -03:00
LICENSE Wrap lines at 79 characters 2016-02-16 19:14:55 +00:00
MANIFEST.in Introduce a task to generate the announcement file for releases 2017-05-09 23:50:08 -03:00
README.rst Add badge for anaconda package version 2017-04-28 12:51:40 -03:00
appveyor.yml Fix pytester internal plugin to work correctly with latest versions of zope.interface 2017-01-19 20:53:35 -02:00
pytest.py remove the namespace hook from mark after the param feature merge 2017-03-28 11:45:06 +02:00
setup.cfg restore setuptools_scm write_to usage 2017-04-23 16:59:08 +02:00
setup.py restore setuptools_scm write_to usage 2017-04-23 16:59:08 +02:00
tox.ini Fix minor regendoc issues 2017-05-15 21:57:04 -03:00

README.rst

.. image:: http://docs.pytest.org/en/latest/_static/pytest1.png
   :target: http://docs.pytest.org
   :align: center
   :alt: pytest

------

.. image:: https://img.shields.io/pypi/v/pytest.svg
    :target: https://pypi.python.org/pypi/pytest

.. image:: https://anaconda.org/conda-forge/pytest/badges/version.svg
    :target: https://anaconda.org/conda-forge/pytest

.. image:: https://img.shields.io/pypi/pyversions/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

The ``pytest`` framework makes it easy to write small tests, yet
scales to support complex functional testing for applications and libraries.

An example of a simple test:

.. code-block:: python

    # content of test_sample.py
    def inc(x):
        return x + 1

    def test_answer():
        assert inc(3) == 5


To execute it::

    $ pytest
    ============================= test session starts =============================
    collected 1 items

    test_sample.py F

    ================================== FAILURES ===================================
    _________________________________ test_answer _________________________________

        def test_answer():
    >       assert inc(3) == 5
    E       assert 4 == 5
    E        +  where 4 = inc(3)

    test_sample.py:5: AssertionError
    ========================== 1 failed in 0.04 seconds ===========================


Due to ``pytest``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <http://docs.pytest.org/en/latest/getting-started.html#our-first-test-run>`_ for more examples.


Features
--------

- Detailed info on failing `assert statements <http://docs.pytest.org/en/latest/assert.html>`_ (no need to remember ``self.assert*`` names);

- `Auto-discovery
  <http://docs.pytest.org/en/latest/goodpractices.html#python-test-discovery>`_
  of test modules and functions;

- `Modular fixtures <http://docs.pytest.org/en/latest/fixture.html>`_ for
  managing small or parametrized long-lived test resources;

- Can run `unittest <http://docs.pytest.org/en/latest/unittest.html>`_ (or trial),
  `nose <http://docs.pytest.org/en/latest/nose.html>`_ test suites out of the box;

- Python2.6+, Python3.3+, PyPy-2.3, Jython-2.5 (untested);

- Rich plugin architecture, with over 150+ `external plugins <http://docs.pytest.org/en/latest/plugins.html#installing-external-plugins-searching>`_ and thriving community;


Documentation
-------------

For full documentation, including installation, tutorials and PDF documents, please see http://docs.pytest.org.


Bugs/Requests
-------------

Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features.


Changelog
---------

Consult the `Changelog <http://docs.pytest.org/en/latest/changelog.html>`__ page for fixes and enhancements of each version.


License
-------

Copyright Holger Krekel and others, 2004-2016.

Distributed under the terms of the `MIT`_ license, pytest is free and open source software.

.. _`MIT`: https://github.com/pytest-dev/pytest/blob/master/LICENSE