Metadata-Version: 2.1
Name: CheckMates
Version: 0.2.0
Summary: CheckMates is an AutoML library which catches and warns of problems with your data and problem setup before modeling.
Author-email: "Alteryx, Inc." <open_source_support@alteryx.com>
Maintainer-email: "Alteryx, Inc." <open_source_support@alteryx.com>
License: BSD-3-Clause
Project-URL: Source Code, https://github.com/alteryx/CheckMates/
Project-URL: Issue Tracker, https://github.com/alteryx/CheckMates/issues
Requires-Python: <4.0,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy <=1.23.5,>=1.21.0
Requires-Dist: pandas >=1.5.0
Requires-Dist: woodwork >=0.22.0
Requires-Dist: click >=8.0.0
Requires-Dist: black[jupyter] >=22.3.0
Provides-Extra: dev
Requires-Dist: ruff ==0.0.228 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: docutils <0.17,>=0.15.2 ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme >=0.3.1 ; extra == 'docs'
Requires-Dist: astroid <=2.6.6 ; extra == 'docs'
Requires-Dist: Sphinx >=4.5.0 ; extra == 'docs'
Requires-Dist: nbconvert >=6.4.5 ; extra == 'docs'
Requires-Dist: nbsphinx <0.9.0,>=0.8.5 ; extra == 'docs'
Requires-Dist: sphinx-autoapi >=1.8.3 ; extra == 'docs'
Requires-Dist: sphinx-inline-tabs ==2022.1.2b11 ; extra == 'docs'
Requires-Dist: sphinx-copybutton ==0.4.0 ; extra == 'docs'
Requires-Dist: myst-parser ==0.16.1 ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ==7.1.2 ; extra == 'test'
Requires-Dist: coverage[toml] >=6.4 ; extra == 'test'

# CheckMates

CheckMates is an Alteryx Open Source library which catches and warns of problems with your data and problem setup before modeling.

## Installation
```bash
python -m pip install checkmates
```
## Start
#### Load and validate example data
```python
from checkmates import (
    IDColumnsDataCheck
)
import pandas as pd

id_data_check_name = IDColumnsDataCheck.name
X_dict = {
        "col_1": [1, 1, 2, 3],
        "col_2": [2, 3, 4, 5],
        "col_3_id": [0, 1, 2, 3],
        "Id": [3, 1, 2, 0],
        "col_5": [0, 0, 1, 2],
        "col_6": [0.1, 0.2, 0.3, 0.4],
    }
X = pd.DataFrame.from_dict(X_dict)
id_cols_check = IDColumnsDataCheck(id_threshold=0.95)
print(id_cols_check.validate(X))
```

## Next Steps

Read more about CheckMates on our [documentation page](#):

## Support

The CheckMates community is happy to provide support to users of CheckMates. Project support can be found in four places depending on the type of question:
1. For usage questions, use [Stack Overflow](#) with the `CheckMates` tag.
2. For bugs, issues, or feature requests start a [Github issue](https://github.com/alteryx/CheckMates/issues).
3. For discussion regarding development on the core library, use [Slack](#).
4. For everything else, the core developers can be reached by email at open_source_support@alteryx.com

## Built at Alteryx

**CheckMates** is an open source project built by [Alteryx](https://www.alteryx.com). To see the other open source projects we’re working on visit [Alteryx Open Source](https://www.alteryx.com/open-source). If building impactful data science pipelines is important to you or your business, please get in touch.

<p align="center">
  <a href="https://www.alteryx.com/open-source">
    <img src="https://alteryx-oss-web-images.s3.amazonaws.com/OpenSource_Logo-01.png" alt="Alteryx Open Source" width="800"/>
  </a>
</p>
