diff --git a/README.md b/README.md index 50700a9..9b2cb27 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,24 @@ [![pypi-version](https://img.shields.io/pypi/v/tabulardelta.svg?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/tabulardelta) [![python-version](https://img.shields.io/pypi/pyversions/tabulardelta?logoColor=white&logo=python&style=flat-square)](https://pypi.org/project/tabulardelta) -Simplify table comparisons. +TabularDelta simplifies the comparison of diverse tables, like SQL tables or Pandas DataFrames. It can both find small deviations in largely similar tables, as well as provide an overview of more structural changes. + +To compare two tables, first select a comparator that supports the table format. Now select any formatter that best suits your use case to obtain a visualization of the result. + +## Usage example + +```python +import pandas as pd +from tabulardelta import PandasComparator, DetailedTextFormatter + +df_old = pd.read_csv("week24.csv", index_col=[0, 1]) +df_new = pd.read_csv("week25.csv", index_col=[0, 1]) + +delta = PandasComparator().compare(df_old, df_new) +print(DetailedTextFormatter().format(delta)) +``` + +To find more examples and get started, please visit the [documentation](https://tabulardelta.readthedocs.io/en/latest/). ## Development @@ -18,7 +35,6 @@ cd tabulardelta pixi run pre-commit-install pixi run postinstall -pixi run test ``` ## Testing