pytest-regressions

================== pytest-regressions

.. image:: https://img.shields.io/pypi/v/pytest-regressions.svg :target: https://pypi.org/project/pytest-regressions :alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/pytest-regressions.svg :target: https://anaconda.org/conda-forge/pytest-regressions

.. image:: https://img.shields.io/pypi/pyversions/pytest-regressions.svg :target: https://pypi.org/project/pytest-regressions :alt: Python versions

.. image:: https://github.com/ESSS/pytest-regressions/workflows/build/badge.svg :target: https://github.com/ESSS/pytest-regressions/actions?query=workflow%3Abuild

.. image:: https://img.shields.io/readthedocs/pytest-regressions.svg :target: https://pytest-regressions.readthedocs.io/en/latest

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black

.. image:: https://results.pre-commit.ci/badge/github/ESSS/pytest-regressions/master.svg :target: https://results.pre-commit.ci/latest/github/ESSS/pytest-regressions/master :alt: pre-commit.ci status

Fixtures to write regression tests.

Features

This plugin makes it simple to test general data, images, files, and numeric tables by saving expected data in a data directory (courtesy of pytest-datadir <https://github.com/gabrielcnr/pytest-datadir>_) that can be used to verify that future runs produce the same data.

See the docs <https://pytest-regressions.readthedocs.io/en/latest>_ for examples and API usage.

Contributing

Contributions are very welcome. Tests can be run with tox_, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT_ license, "pytest-regressions" is free and open source software

Issues

If you encounter any problems, please file an issue_ along with a detailed description.

This pytest_ plugin was generated with Cookiecutter_ along with @hackebrot's cookiecutter-pytest-plugin template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _@hackebrot: https://github.com/hackebrot .. _MIT: http://opensource.org/licenses/MIT .. _BSD-3: http://opensource.org/licenses/BSD-3-Clause .. _GNU GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.txt .. _Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0 .. _cookiecutter-pytest-plugin: https://github.com/pytest-dev/cookiecutter-pytest-plugin .. _file an issue: https://github.com/nicoddemus/pytest-regressions/issues .. _pytest: https://github.com/pytest-dev/pytest .. _tox: https://tox.readthedocs.io/en/latest/ .. _pip: https://pypi.org/project/pip/ .. _PyPI: https://pypi.org/project