Metadata-Version: 2.0
Name: diffport
Version: 0.2.1
Summary: Database summary diff reporting tool
Home-page: https://github.com/reichlab/diffport
Author: Abhinav Tushar
Author-email: abhinav.tushar.vs@gmail.com
License: UNKNOWN
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: colorama
Requires-Dist: dataset
Requires-Dist: docopt
Requires-Dist: jinja2
Requires-Dist: psycopg2
Requires-Dist: pyyaml
Requires-Dist: tabulate

diffport
========

.. image:: https://img.shields.io/travis/reichlab/diffport.svg?style=flat-square
    :target: https://travis-ci.org/reichlab/diffport

.. image:: https://img.shields.io/pypi/v/diffport.svg?style=flat-square
    :target: https://pypi.python.org/pypi/diffport

Diffport is a database summary diff reporting tool. It helps in maintaining,
diffing and reporting summaries from a database based on a desired set of
*watchers*.

Usage
-----

Diffport works by using a set of *watchers* to take snapshots of database at
different times and then producing a difference report when asked for it.
It uses a config file specifying these watchers and their own specific
configuration. An example follows::

   # diffport.yaml
   - name: number-of-rows
     config:
       groupby:
         - <groupby-column>
         - <groupby-column>
       table: <table-name>

   - name: tables-in-schema
     config: <table-name>

Command line usage instruction can be found by using ``diffport --help``.

Diffport needs environment variable ``DATABASE_URL`` to be set for connecting to
a database. A sample value for postgres follows (see `here
<https://dataset.readthedocs.io/en/latest/quickstart.html#connecting-to-a-database>`_
for more)::

  postgresql://scott:tiger@localhost:5432/mydatabase


