From d193a8e17a19c42c630c174ed2be79190b729940 Mon Sep 17 00:00:00 2001 From: AaronTackeQC <156931896+AaronTackeQC@users.noreply.github.com> Date: Thu, 15 Aug 2024 20:51:33 +0200 Subject: [PATCH] docs: Make readme more presentable (#4) --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3565bc4..e409d65 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,26 @@ [![pypi-version](https://img.shields.io/pypi/v/sqlcompyre.svg?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/sqlcompyre) [![python-version](https://img.shields.io/pypi/pyversions/sqlcompyre?logoColor=white&logo=python&style=flat-square)](https://pypi.org/project/sqlcompyre) -SQLCompyre is a simple Python package that allows you to find and explore the differences between -SQL tables, schemas, and entire databases. +SQLCompyre is a simple Python package that allows you to find and explore the differences between SQL tables, schemas, and entire databases. It provides both a Python interface and a CLI, allowing it to be used for both ad-hoc comparisons as well as in-depth analyses. + +SQLCompyre is designed to be dialect-agnostic and should, thus, work with most database systems out-of-the-box. + +## Usage example + +Given a connection to a database, this snippet will print a report of the differences between two tables: + +```python +import sqlalchemy as sa +import sqlcompyre as sc + +engine = sa.create_engine("") +comparison = sc.compare_tables(engine, "", "") + +report = comparison.summary_report() +print(report) +``` + +To find more examples and get started, please visit the [documentation](https://sqlcompyre.readthedocs.io/en/latest/). ## Installation