Merge pull request #11 from alteryx/first_release

release v0.1.0 CheckMates

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
 blank_issues_enabled: true
 contact_links:
   - name: General Technical Question
-    about: "If you have a question like *How can I check for ID Columns?* you can ask on StackOverflow using the #checkers tag."
-    url: https://stackoverflow.com/questions/tagged/checkers
+    about: "If you have a question like *How can I check for ID Columns?* you can ask on StackOverflow using the #checkmates tag."
+    url: https://stackoverflow.com/questions/tagged/checkmates
   - name: Real-time chat
     url: https://join.slack.com/t/alteryx-oss/shared_invite/zt-182tyvuxv-NzIn6eiCEf8TBziuKp0bNA
     about: "If you want to meet others in the community and chat about all things Alteryx OSS then check out our Slack."

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-- As a [user/developer], I wish I could use Checkers to ...
+- As a [user/developer], I wish I could use CheckMates to ...
 
 #### Code Example
 

.github/workflows/lint_tests.yaml

@@ -29,11 +29,11 @@ jobs:
         with:
           path: ${{ env.pythonLocation }}
           key: ${{ matrix.python_version }}-lint-${{ env.pythonLocation }}-${{ hashFiles('**/pyproject.toml') }}-v01
-      - name: Install checkers with dev requirements (not using cache)
+      - name: Install CheckMates with dev requirements (not using cache)
         if: steps.cache.outputs.cache-hit != 'true'
         run: |
           python -m pip install -e .[dev]
-      - name: Install checkers with no requirements (using cache)
+      - name: Install CheckMates with no requirements (using cache)
         if: steps.cache.outputs.cache-hit == 'true'
         run: |
           python -m pip install -e .[dev] --no-deps

.gitignore

@@ -1,6 +1,6 @@
 .venv/
 **/__pycache__/
 .DS_Store
-Checkers.egg-info/
+Checkmates.egg-info/
 .python-version
 pdm.lock

README.md

@@ -1,26 +1,26 @@
-# Checkers
+# CheckMates
 
-Checkers is an Alteryx Open Source library which catches and warns of problems with your data and problem setup before modeling.
+CheckMates is an Alteryx Open Source library which catches and warns of problems with your data and problem setup before modeling.
 
 ## Installation
 
 ## Start
 
 ## Next Steps
 
-Read more about Checkers on our [documentation page](#):
+Read more about CheckMates on our [documentation page](#):
 
 ## Support
 
-The Checkers community is happy to provide support to users of Checkers. Project support can be found in four places depending on the type of question:
-1. For usage questions, use [Stack Overflow](#) with the `checkers` tag.
+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](#).
 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
 
-**Checkers** 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.
+**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">

checkmates/__init__.py

@@ -0,0 +1,45 @@
+"""General CheckMates directory."""
+
+from checkmates.data_checks.checks.data_check import DataCheck
+from checkmates.data_checks.datacheck_meta.data_check_message_code import (
+    DataCheckMessageCode,
+)
+from checkmates.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmates.data_checks.datacheck_meta.data_check_action_option import (
+    DataCheckActionOption,
+    DCAOParameterType,
+    DCAOParameterAllowedValuesType,
+)
+from checkmates.data_checks.datacheck_meta.data_check_action_code import (
+    DataCheckActionCode,
+)
+from checkmates.data_checks.checks.data_checks import DataChecks
+from checkmates.data_checks.datacheck_meta.data_check_message import (
+    DataCheckMessage,
+    DataCheckWarning,
+    DataCheckError,
+)
+from checkmates.data_checks.datacheck_meta.data_check_message_type import (
+    DataCheckMessageType,
+)
+from checkmates.data_checks.checks.id_columns_data_check import IDColumnsDataCheck
+
+from checkmates.problem_types.problem_types import ProblemTypes
+from checkmates.problem_types.utils import (
+    handle_problem_types,
+    detect_problem_type,
+    is_regression,
+    is_binary,
+    is_multiclass,
+    is_classification,
+    is_time_series,
+)
+
+from checkmates.exceptions.exceptions import (
+    DataCheckInitError,
+    MissingComponentError,
+    ValidationErrorCode,
+)
+
+from checkmates.utils.gen_utils import classproperty
+from checkmates.utils.woodwork_utils import infer_feature_types

checkmates/data_checks/__init__.py

@@ -0,0 +1,27 @@
+"""Base data checks and ID column data check."""
+
+from checkmates.data_checks.checks.data_check import DataCheck
+from checkmates.data_checks.datacheck_meta.data_check_message_code import (
+    DataCheckMessageCode,
+)
+from checkmates.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmates.data_checks.datacheck_meta.data_check_action_option import (
+    DataCheckActionOption,
+    DCAOParameterType,
+    DCAOParameterAllowedValuesType,
+)
+from checkmates.data_checks.datacheck_meta.data_check_action_code import (
+    DataCheckActionCode,
+)
+from checkmates.data_checks.checks.data_checks import DataChecks
+from checkmates.data_checks.datacheck_meta.data_check_message import (
+    DataCheckMessage,
+    DataCheckWarning,
+    DataCheckError,
+)
+from checkmates.data_checks.datacheck_meta.data_check_message_type import (
+    DataCheckMessageType,
+)
+from checkmates.data_checks.checks.id_columns_data_check import IDColumnsDataCheck
+
+from checkmates.data_checks.datacheck_meta.utils import handle_data_check_action_code

checkers/data_checks/checks/data_check.py → checkmates/data_checks/checks/data_check.py

@@ -1,7 +1,7 @@
 """Base class for all data checks."""
 from abc import ABC, abstractmethod
 
-from checkers.utils import classproperty
+from checkmates.utils import classproperty
 
 
 class DataCheck(ABC):

checkers/data_checks/checks/data_checks.py → checkmates/data_checks/checks/data_checks.py

@@ -1,9 +1,9 @@
 """A collection of data checks."""
 import inspect
 
-from checkers.data_checks import DataCheck
-from checkers.exceptions import DataCheckInitError
-from checkers.utils import infer_feature_types
+from checkmates.data_checks import DataCheck
+from checkmates.exceptions import DataCheckInitError
+from checkmates.utils import infer_feature_types
 
 
 def _has_defaults_for_all_args(init):

checkers/data_checks/checks/id_columns_data_check.py → checkmates/data_checks/checks/id_columns_data_check.py

@@ -1,13 +1,13 @@
 """Data check that checks if any of the features are likely to be ID columns."""
 
-from checkers.data_checks import (
+from checkmates.data_checks import (
     DataCheck,
     DataCheckActionCode,
     DataCheckActionOption,
     DataCheckMessageCode,
     DataCheckWarning,
 )
-from checkers.utils import infer_feature_types
+from checkmates.utils import infer_feature_types
 
 
 class IDColumnsDataCheck(DataCheck):

checkers/data_checks/datacheck_meta/data_check_action.py → checkmates/data_checks/datacheck_meta/data_check_action.py

@@ -1,9 +1,9 @@
 """Recommended action returned by a DataCheck."""
 
-from checkers.data_checks.datacheck_meta.data_check_action_code import (
+from checkmates.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
-from checkers.data_checks.datacheck_meta.utils import handle_data_check_action_code
+from checkmates.data_checks.datacheck_meta.utils import handle_data_check_action_code
 
 
 class DataCheckAction:

checkers/data_checks/datacheck_meta/data_check_action_code.py → checkmates/data_checks/datacheck_meta/data_check_action_code.py

@@ -1,7 +1,7 @@
 """Enum for data check action code."""
 from enum import Enum
 
-from checkers.utils import classproperty
+from checkmates.utils import classproperty
 
 
 class DataCheckActionCode(Enum):

checkers/data_checks/datacheck_meta/data_check_action_option.py → checkmates/data_checks/datacheck_meta/data_check_action_option.py

@@ -1,11 +1,11 @@
 """Recommended action returned by a DataCheck."""
 from enum import Enum
 
-from checkers.data_checks.datacheck_meta.data_check_action import DataCheckAction
-from checkers.data_checks.datacheck_meta.data_check_action_code import (
+from checkmates.data_checks.datacheck_meta.data_check_action import DataCheckAction
+from checkmates.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
-from checkers.utils import classproperty
+from checkmates.utils import classproperty
 
 
 class DataCheckActionOption:

checkers/data_checks/datacheck_meta/data_check_message.py → checkmates/data_checks/datacheck_meta/data_check_message.py

@@ -1,5 +1,5 @@
 """Messages returned by a DataCheck, tagged by name."""
-from checkers.data_checks.datacheck_meta.data_check_message_type import (
+from checkmates.data_checks.datacheck_meta.data_check_message_type import (
     DataCheckMessageType,
 )
 

checkers/data_checks/datacheck_meta/utils.py → checkmates/data_checks/datacheck_meta/utils.py

@@ -1,5 +1,5 @@
 """Utility methods for the data checks in DataChecks."""
-from checkers.data_checks.datacheck_meta.data_check_action_code import (
+from checkmates.data_checks.datacheck_meta.data_check_action_code import (
     DataCheckActionCode,
 )
 

checkers/exceptions/__init__.py → checkmates/exceptions/__init__.py

@@ -1,5 +1,5 @@
 """Exceptions used in DataChecks."""
-from checkers.exceptions.exceptions import (
+from checkmates.exceptions.exceptions import (
     DataCheckInitError,
     MissingComponentError,
     ValidationErrorCode,

checkers/problem_types/__init__.py → checkmates/problem_types/__init__.py

@@ -1,6 +1,6 @@
 """The supported types of machine learning problems."""
-from checkers.problem_types.problem_types import ProblemTypes
-from checkers.problem_types.utils import (
+from checkmates.problem_types.problem_types import ProblemTypes
+from checkmates.problem_types.utils import (
     handle_problem_types,
     detect_problem_type,
     is_regression,

checkers/problem_types/problem_types.py → checkmates/problem_types/problem_types.py

@@ -1,7 +1,7 @@
 """Enum defining the supported types of machine learning problems."""
 from enum import Enum
 
-from checkers.utils import classproperty
+from checkmates.utils import classproperty
 
 
 class ProblemTypes(Enum):

checkers/problem_types/utils.py → checkmates/problem_types/utils.py

@@ -2,7 +2,7 @@
 import pandas as pd
 from pandas.api.types import is_numeric_dtype
 
-from checkers.problem_types.problem_types import ProblemTypes
+from checkmates.problem_types.problem_types import ProblemTypes
 
 
 def handle_problem_types(problem_type):

checkmates/utils/__init__.py

@@ -0,0 +1,3 @@
+"""Utility methods."""
+from checkmates.utils.gen_utils import classproperty
+from checkmates.utils.woodwork_utils import infer_feature_types

contributing.md

@@ -12,7 +12,7 @@ We currently utilize GitHub Issues as our project management tool for datachecks
 
 #### 1. Clone repo
 The code is hosted on GitHub, so you will need to use Git to clone the project and make changes to the codebase. Once you have obtained a copy of the code, you should create a development environment that is separate from your existing Python environment so that you can make and test changes without compromising your own work environment. Additionally, you must make sure that the version of Python you use is at least 3.8. Using `conda` you can use `conda create -n datachecks python=3.8` and `conda activate datachecks` before the following steps.
-* clone with `git clone [https://github.com/alteryx/Checkers.git]`
+* clone with `git clone [https://github.com/alteryx/CheckMates.git]`
 * install in edit mode with:
     ```bash
     # move into the repo