Metadata-Version: 1.2
Name: datatest
Version: 0.10.0
Summary: Test driven data-wrangling and data validation.
Home-page: https://pypi.org/project/datatest/
Author: Shawn Brown
License: Apache 2.0
Description: 
        ********************************************************
        datatest: Test driven data-wrangling and data validation
        ********************************************************
        
        ..
            Project badges for quick reference:
        
        |buildstatus| |devstatus| |license| |pyversions|
        
        
        .. start-inclusion-marker-description
        
        Datatest helps to speed up and formalize data-wrangling and data
        validation tasks. It repurposes software testing practices for
        data preparation and quality assurance projects. Datatest can
        help you:
        
        * Clean and wrangle data faster and more accurately.
        * Maintain a record of checks and decisions regarding important data sets.
        * Distinguish between ideal criteria and acceptible deviation.
        * Validate data pipeline component input and output.
        * Measure progress of data preparation tasks.
        * On-board new team members with an explicit and structured process.
        
        Datatest can be used directly in your own projects or as part of
        a testing framework like pytest_ or unittest_. It implements a
        system of validation methods, difference classes, and acceptance
        context managers.
        
        Datatest has no hard dependencies; it's tested on Python 2.6, 2.7,
        3.2 through 3.10, PyPy, and PyPy3; and is freely 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)
            | https://datatest.readthedocs.io/en/latest/ (latest)
        
        :Official:
            | https://pypi.org/project/datatest/
        
        
        Installation
        ============
        
        .. start-inclusion-marker-install
        
        The easiest way to install datatest is to use `pip <https://pip.pypa.io>`_::
        
          pip install datatest
        
        To upgrade an existing installation, use the "``--upgrade``" option::
        
          pip install --upgrade datatest
        
        
        Stuntman Mike
        -------------
        
        If you need bug-fixes or features that are not available
        in the current stable release, you can "pip install" the
        development version directly from GitHub::
        
          pip install --upgrade https://github.com/shawnbrown/datatest/archive/master.zip
        
        All of the usual caveats for a development install should
        apply---only use this version if you can risk some instability
        or if you know exactly what you're doing. While care is taken
        to never break the build, it can happen.
        
        
        Safety-first Clyde
        ------------------
        
        If you need to review and test packages before installing, you can
        install datatest manually.
        
        Download the latest **source** distribution from the Python Package
        Index (PyPI):
        
          https://pypi.org/project/datatest/ (navigate to "Download files")
        
        Unpack the file (replacing X.Y.Z with the appropriate version number)
        and review the source code::
        
          tar xvfz datatest-X.Y.Z.tar.gz
        
        Change to the unpacked directory and run the tests::
        
          cd datatest-X.Y.Z
          python setup.py test
        
        Don't worry if some of the tests are skipped. Tests for optional data
        sources (like pandas DataFrames or NumPy arrays) are skipped when the
        related third-party packages are not installed.
        
        If the source code and test results are satisfactory, install the
        package::
        
          python setup.py install
        
        .. end-inclusion-marker-install
        
        
        Supported Versions
        ==================
        
        Tested on Python 2.6, 2.7, 3.2 through 3.10, PyPy, and PyPy3.
        Datatest is pure Python and may also run on other implementations
        as well (check using "setup.py test" before installing).
        
        
        Backward Compatibility
        ======================
        
        If you have existing tests that use API features which have
        changed since 0.9.0, you can still run your old code by
        adding the following import to the beginning of each file::
        
          from datatest.__past__ import api09
        
        To maintain existing test code, this project makes a best-effort
        attempt to provide backward compatibility support for older
        features. The API will be improved in the future but only in
        measured and sustainable ways.
        
        All of the data used at the `National Committee for an Effective
        Congress <http://www.ncec.org/about>`_ has been checked with
        datatest for several years so there is, already, a large and
        growing codebase that relies on current features and must be
        maintained into the future.
        
        
        Soft Dependencies
        =================
        
        Datatest has no hard, third-party dependencies. But if you want
        to interface with pandas DataFrames, NumPy arrays, or other
        optional data sources, you will need to install the relevant
        packages (``pandas``, ``numpy``, etc.).
        
        
        Development Repository
        ======================
        
        The development repository for ``datatest`` is hosted on
        `GitHub <https://github.com/shawnbrown/datatest>`_.
        
        
        ----------
        
        Freely licensed under the Apache License, Version 2.0
        
        Copyright 2014 - 2021 National Committee for an Effective Congress, et al.
        
        
        ..
          SUBSTITUTION DEFINITONS:
        
        .. |buildstatus| image:: https://travis-ci.org/shawnbrown/datatest.svg?branch=master
            :target: https://travis-ci.org/shawnbrown/datatest
            :alt: Current Build Status
        
        .. |devstatus| image:: https://img.shields.io/pypi/status/datatest.svg
            :target: https://pypi.org/project/datatest/
            :alt: Development Status
        
        .. |license| image:: https://img.shields.io/badge/license-Apache%202-blue.svg
            :target: https://opensource.org/licenses/Apache-2.0
            :alt: Apache 2.0 License
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/datatest.svg
            :target: https://pypi.org/project/datatest/#supported-versions
            :alt: Supported Python Versions
        
        .. |githubstars| image:: https://img.shields.io/github/stars/shawnbrown/datatest.svg
            :target: https://github.com/shawnbrown/datatest/stargazers
            :alt: GitHub users who have starred this project
        
        .. |pypiversion| image:: https://img.shields.io/pypi/v/datatest.svg
            :target: https://pypi.org/project/datatest/
            :alt: Current PyPI Version
        
        
Platform: UNKNOWN
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.6.*, !=3.0.*, !=3.1.*
