/
overview.txt
26 lines (20 loc) · 1.15 KB
/
overview.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Overview
========
The :py:mod:`tdda` package provides Python support for
test-driven data analysis
(see `1-page summary <http://stochasticsolutions.com/pdf/TDDA-One-Pager.pdf>`_
with references, or the `blog <http://www.tdda.info/pages/table-of-contents.html#table-of-contents>`_)
* The :py:mod:`tdda.referencetest` library is used to support the creation of
*reference tests*, based on either :py:mod:`unittest` or :py:mod:`pytest`.
* The :py:mod:`tdda.constraints` library is used to *discover* constraints
from a (Pandas) DataFrame, write them out as JSON, and to *verify* that
datasets meet the constraints in the constraints file. It also supports
tables in a variety of relation databases.
There is also a command-line utility for discovering and verifying
constraints, and detecting failing records.
* The :py:mod:`tdda.rexpy` library is a tool for automatically
inferring regular expressions from a column in a Pandas DataFrame
or from a (Python) list of examples.
There is also a command-line utility for Rexpy.
Although the library is provided as a Python package, and can be called
through its Python API, it also provides command-line tools.