Skip to content

Commit

Permalink
Update introduction and table of contents file in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnbrown committed Jan 2, 2021
1 parent c96e1c5 commit 5a07c68
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 14 deletions.
4 changes: 0 additions & 4 deletions README.rst
Expand Up @@ -9,8 +9,6 @@ datatest: Test driven data-wrangling and data validation
|buildstatus| |devstatus| |license| |pyversions|


.. start-inclusion-marker-description
Datatest helps to speed up and formalize data-wrangling and data
validation tasks. It implements a system of validation methods,
difference classes, and acceptance managers. Datatest can help you:
Expand All @@ -30,8 +28,6 @@ available under the Apache License, version 2.
.. _pytest: https://pytest.org
.. _unittest: https://docs.python.org/library/unittest.html

.. end-inclusion-marker-description

:Documentation:
| https://datatest.readthedocs.io/ (stable)
Expand Down
46 changes: 36 additions & 10 deletions docs/index.rst
@@ -1,9 +1,9 @@
:tocdepth: 2

.. meta::
:description: Table of Contents for Datatest.
:keywords: datatest, validation, wrangling, data pipeline, testing
:title: Index
:description: Datatest introduction and table of contents.
:keywords: data cleaning, data quality, etl testing, data validation, data testing, data preparation, python, datatest
:title: Datatest: Test driven data-wrangling and data validation.

.. module:: datatest
:synopsis: Test driven data-wrangling and data validation.
Expand All @@ -17,13 +17,39 @@ Datatest: Test driven data-wrangling and data validation

Version |release|

.. include:: ../README.rst
:start-after: start-inclusion-marker-description
:end-before: end-inclusion-marker-description

See the project's `README <https://pypi.org/project/datatest/>`_
file for full details regarding supported versions, backward
compatibility, and more.
Datatest helps to speed up and formalize data-wrangling and data
validation tasks. It was designed to work with poorly formatted
data by detecting and describing validation failures.

* |Validate| the format, type, set membership, and more from a variety of
data sources including pandas ``DataFrames`` and ``Series``, NumPy
``ndarrays``, built-in data structures, etc.
* Smart |comparison behavior| applies the appropriate validation method for
a given data requirement.
* Automatic |data handling| manages the validation of single elements,
sequences, sets, dictionaries, and other containers of elements.
* |Difference objects| characterize the discrepancies and deviations
between a dataset and its requirements.
* |Acceptance managers| distinguish between ideal criteria and acceptable
differences.

.. |Validate| replace:: :ref:`Validate <intro-validation>`
.. |comparison behavior| replace:: :ref:`comparison behavior <intro-smart-comparisons>`
.. |data handling| replace:: :ref:`data handling <intro-automatic-data-handling>`
.. |Difference objects| replace:: :ref:`Difference objects <intro-difference-objects>`
.. |Acceptance managers| replace:: :ref:`Acceptance managers <intro-acceptance-managers>`


**Test driven data-wrangling** is a process for taking data from a source
of unverified quality or format and producing a verified, well-formatted
dataset. It repurposes software testing practices for data preparation
and quality assurance projects. **Pipeline validation** monitors the status
and quality of data as it passes through a pipeline and identifies *where*
in a pipeline an error occurs.

See the project `README <https://pypi.org/project/datatest/>`_ file for
full details regarding supported versions, backward compatibility, and
more.


=================
Expand Down

0 comments on commit 5a07c68

Please sign in to comment.