============ Dictdiffer

.. image:: https://github.com/inveniosoftware/dictdiffer/workflows/CI/badge.svg :target: https://github.com/inveniosoftware/dictdiffer/actions

.. image:: https://img.shields.io/coveralls/inveniosoftware/dictdiffer.svg :target: https://coveralls.io/r/inveniosoftware/dictdiffer

.. image:: https://img.shields.io/github/tag/inveniosoftware/dictdiffer.svg :target: https://github.com/inveniosoftware/dictdiffer/releases

.. image:: https://img.shields.io/pypi/dm/dictdiffer.svg :target: https://pypi.python.org/pypi/dictdiffer

.. image:: https://img.shields.io/github/license/inveniosoftware/dictdiffer.svg :target: https://github.com/inveniosoftware/dictdiffer/blob/master/LICENSE

About

Dictdiffer is a helper module that helps you to diff and patch dictionaries.

Installation

Dictdiffer is on PyPI so all you need is: ::

pip install dictdiffer

Documentation

Documentation is readable at https://dictdiffer.readthedocs.io or can be built using Sphinx: ::

pip install dictdiffer[docs]
python setup.py build_sphinx

Testing

Running the test suite is as simple as: ::

./run-tests.sh