Go to file
Bruno Oliveira 84a476af87 Use pypi version badge from shields.io
The old one from pypip.in seems to always be broken as of late
2015-06-15 23:03:53 -03:00
_pytest Change links from bitbucket to GitHub 2015-06-15 18:28:31 -03:00
appveyor appveyor scripts 2015-06-16 03:25:28 +02:00
bench simplify internal pytester machinery 2014-10-06 13:37:57 +02:00
doc/en Update sidebar links from Bitbucket to GitHub 2015-06-15 19:18:03 -03:00
extra another update for get_issues.py to account for repository move 2015-02-27 09:12:00 -05:00
testing Change links from bitbucket to GitHub 2015-06-15 18:28:31 -03:00
.gitignore .gitignore: Removed *.html rule 2013-12-12 18:48:09 +01:00
.travis.yml Merge pull request #771 from pytest-dev/use-travis-containers 2015-06-15 19:56:34 -03:00
AUTHORS sort AUTHORS and add Janne 2015-06-06 13:38:25 +02:00
CHANGELOG add Janne`s changes to CHANGELOG 2015-06-06 11:53:34 +02:00
CONTRIBUTING.rst Update CONTRIBUTING documentation with GitHub instructions 2015-06-15 18:54:44 -03:00
HOWTORELEASE.rst Add how to upload a wheel and tag the release 2015-05-19 09:32:21 +01: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
Makefile use regendoc normalization and regenerate docs 2015-06-06 23:30:49 +02:00
README.rst Use pypi version badge from shields.io 2015-06-15 23:03:53 -03:00
appveyor.yml appveyor integration 2015-06-16 02:58:07 +02:00
plugin-test.sh add pluginmanager.do_configure(config) as a link to 2013-10-04 11:36:45 +02:00
pytest.py adapt to pluggy naming, rename pytest.hookspec_opts to pytest.hookspec,s ame with hookimpl_opts 2015-05-06 10:08:08 +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 Add support for building proper wheels (universal and proper dependency evnironment markers for argparse/colorama if setuptools is new-ish). 2015-04-10 21:08:50 +03:00
setup.py make default depend on just published py/pluggy releases 2015-05-07 11:50:08 +02:00
tox.ini pass coveralls env 2015-06-16 02:38:52 +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.png
   :target: https://pypi.python.org/pypi/pytest
.. image:: https://coveralls.io/repos/pytest-dev/pytest/badge.png?branch=master
   :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.4, 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-2014
Licensed under the MIT license.