Metadata-Version: 2.1
Name: pretty-good-diff
Version: 0.1.0
Summary: Gives you a pretty good diff between two objects
Home-page: https://github.com/Viktor-Bubanja/pretty-good-diff
Author: Viktor Bubanja
Author-email: viktor.bubanja@hotmail.com
Project-URL: repository, https://github.com/Viktor-Bubanja/pretty-good-diff
Keywords: diff,difference,checker,highlight,color,colour,colored,coloured
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# Pretty Good Diff

This tool allows developers to compare two objects and see a highlight of the differences between them. It works with strings and dictionaries.
This project was made to help me fix unit tests with failing assertions quicker, especially when the objects are huge or very nested and complicated.
I simply call `show_diff` on the two objects before an assert statement.

## show_diff
Import the `show_diff` method like `from pretty_good_diff import show_diff`.

Then, call `show_diff(first_object, second_object)` to see a colored diff of the input objects. `first_object` and `second_object` need to have the same type and be either `str` or `dict` objects.

Before:
![alt text](https://github.com/Viktor-Bubanja/pretty-good-diff/raw/main/blob/ugly_diff.png)

After:
![alt text](https://github.com/Viktor-Bubanja/pretty-good-diff/raw/main/blob/pretty_good_diff.png)
