pytest-icdiff

use icdiff for better error messages in pytest assertions

Description

=============
pytest-icdiff
=============

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

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

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

Better diffs in `pytest`_ assertion error messages using  `ICDiff`_.

Usage
-----

    pip install pytest-icdiff

Once you've installed it, ``pytest`` will produce nice colourised diffs for any ``assert ==`` :

.. image:: https://raw.githubusercontent.com/hjwp/pytest-icdiff/main/example_output.png?raw=true
   :alt: example colourised diff

Issues and PRs welcome.

Thanks to the maintainers of `ICDiff`_ and also `pprintpp`_ !

License
-------

Distributed under the terms of the `Unlicense`_ license, "pytest-icdiff" is free and open source software

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
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`Unlicense`: http://unlicense.org
.. _`icdiff`: https://www.jefftk.com/icdiff
.. _`pprintpp`: https://github.com/wolever/pprintpp

History
-------

0.3 (2020-01-28)
~~~~~~~~~~~~~~~~

* Disable colorization in sync with Pytest
  (`PR #12 <https://github.com/hjwp/pytest-icdiff/pull/12>`__).
* Synchronize license in `setup.py` with LICENSE file
  (`PR #11 <https://github.com/hjwp/pytest-icdiff/pull/11>`__).
* Show expression drill down small numbers
  (`Issue #5 <https://github.com/hjwp/pytest-icdiff/issues/5>`__).
* Test with Python 3.8
  (`PR #15 <https://github.com/hjwp/pytest-icdiff/issues/15>`__).

0.2 (2019-03-28)
~~~~~~~~~~~~~~~~

* Obey terminal width.

0.0.4 (2018-08-26)
~~~~~~~~~~~~~~~~~~

* Fix for short expressions
  (`Issue #6 <https://github.com/hjwp/pytest-icdiff/issues/6>`__).

0.0.3 (2018-08-10)
~~~~~~~~~~~~~~~~~~

* Add Conda Forge installation and badge
  (`PR #2 <https://github.com/hjwp/pytest-icdiff/pull/2>`__).
* Fix PyPI License classifier
  (`Issue #3 <https://github.com/hjwp/pytest-icdiff/issues/3>`__).
* Fix colorization when both sides contain differences
  (`Issue #4 <https://github.com/hjwp/pytest-icdiff/issues/4>`__).

0.0.2 (2018-08-08)
~~~~~~~~~~~~~~~~~~

* Fix Travis link in README.

0.0.1 (2018-08-08)
~~~~~~~~~~~~~~~~~~

* First release on PyPI.