diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 2fcb1b5..ce8b31d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.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." diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 21e0b2c..6ecda2e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.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 diff --git a/.github/workflows/lint_tests.yaml b/.github/workflows/lint_tests.yaml index 66f9f97..b0db580 100644 --- a/.github/workflows/lint_tests.yaml +++ b/.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 diff --git a/.gitignore b/.gitignore index 3a149bd..248b615 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ .venv/ **/__pycache__/ .DS_Store -Checkers.egg-info/ +Checkmates.egg-info/ .python-version pdm.lock \ No newline at end of file diff --git a/README.md b/README.md index 09794bd..89a0b6a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# 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 @@ -8,19 +8,19 @@ Checkers is an Alteryx Open Source library which catches and warns of problems w ## 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.

diff --git a/checkers/__init__.py b/checkers/__init__.py deleted file mode 100644 index 0af795c..0000000 --- a/checkers/__init__.py +++ /dev/null @@ -1,45 +0,0 @@ -"""General checkers directory.""" - -from checkers.data_checks.checks.data_check import DataCheck -from checkers.data_checks.datacheck_meta.data_check_message_code import ( - DataCheckMessageCode, -) -from checkers.data_checks.datacheck_meta.data_check_action import DataCheckAction -from checkers.data_checks.datacheck_meta.data_check_action_option import ( - DataCheckActionOption, - DCAOParameterType, - DCAOParameterAllowedValuesType, -) -from checkers.data_checks.datacheck_meta.data_check_action_code import ( - DataCheckActionCode, -) -from checkers.data_checks.checks.data_checks import DataChecks -from checkers.data_checks.datacheck_meta.data_check_message import ( - DataCheckMessage, - DataCheckWarning, - DataCheckError, -) -from checkers.data_checks.datacheck_meta.data_check_message_type import ( - DataCheckMessageType, -) -from checkers.data_checks.checks.id_columns_data_check import IDColumnsDataCheck - -from checkers.problem_types.problem_types import ProblemTypes -from checkers.problem_types.utils import ( - handle_problem_types, - detect_problem_type, - is_regression, - is_binary, - is_multiclass, - is_classification, - is_time_series, -) - -from checkers.exceptions.exceptions import ( - DataCheckInitError, - MissingComponentError, - ValidationErrorCode, -) - -from checkers.utils.gen_utils import classproperty -from checkers.utils.woodwork_utils import infer_feature_types diff --git a/checkers/data_checks/__init__.py b/checkers/data_checks/__init__.py deleted file mode 100644 index 95476ab..0000000 --- a/checkers/data_checks/__init__.py +++ /dev/null @@ -1,27 +0,0 @@ -"""Base data checks and ID column data check.""" - -from checkers.data_checks.checks.data_check import DataCheck -from checkers.data_checks.datacheck_meta.data_check_message_code import ( - DataCheckMessageCode, -) -from checkers.data_checks.datacheck_meta.data_check_action import DataCheckAction -from checkers.data_checks.datacheck_meta.data_check_action_option import ( - DataCheckActionOption, - DCAOParameterType, - DCAOParameterAllowedValuesType, -) -from checkers.data_checks.datacheck_meta.data_check_action_code import ( - DataCheckActionCode, -) -from checkers.data_checks.checks.data_checks import DataChecks -from checkers.data_checks.datacheck_meta.data_check_message import ( - DataCheckMessage, - DataCheckWarning, - DataCheckError, -) -from checkers.data_checks.datacheck_meta.data_check_message_type import ( - DataCheckMessageType, -) -from checkers.data_checks.checks.id_columns_data_check import IDColumnsDataCheck - -from checkers.data_checks.datacheck_meta.utils import handle_data_check_action_code diff --git a/checkers/utils/__init__.py b/checkers/utils/__init__.py deleted file mode 100644 index 464d3d7..0000000 --- a/checkers/utils/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -"""Utility methods.""" -from checkers.utils.gen_utils import classproperty -from checkers.utils.woodwork_utils import infer_feature_types diff --git a/checkmates/__init__.py b/checkmates/__init__.py new file mode 100644 index 0000000..4a3c72e --- /dev/null +++ b/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 diff --git a/checkmates/data_checks/__init__.py b/checkmates/data_checks/__init__.py new file mode 100644 index 0000000..d7e63b8 --- /dev/null +++ b/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 diff --git a/checkers/data_checks/checks/data_check.py b/checkmates/data_checks/checks/data_check.py similarity index 95% rename from checkers/data_checks/checks/data_check.py rename to checkmates/data_checks/checks/data_check.py index 843947b..27af24e 100644 --- a/checkers/data_checks/checks/data_check.py +++ b/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): diff --git a/checkers/data_checks/checks/data_checks.py b/checkmates/data_checks/checks/data_checks.py similarity index 96% rename from checkers/data_checks/checks/data_checks.py rename to checkmates/data_checks/checks/data_checks.py index 6fd41f6..97b679f 100644 --- a/checkers/data_checks/checks/data_checks.py +++ b/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): diff --git a/checkers/data_checks/checks/id_columns_data_check.py b/checkmates/data_checks/checks/id_columns_data_check.py similarity index 99% rename from checkers/data_checks/checks/id_columns_data_check.py rename to checkmates/data_checks/checks/id_columns_data_check.py index 74bbddf..d724002 100644 --- a/checkers/data_checks/checks/id_columns_data_check.py +++ b/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): diff --git a/checkers/data_checks/datacheck_meta/data_check_action.py b/checkmates/data_checks/datacheck_meta/data_check_action.py similarity index 94% rename from checkers/data_checks/datacheck_meta/data_check_action.py rename to checkmates/data_checks/datacheck_meta/data_check_action.py index 4802c45..282120e 100644 --- a/checkers/data_checks/datacheck_meta/data_check_action.py +++ b/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: diff --git a/checkers/data_checks/datacheck_meta/data_check_action_code.py b/checkmates/data_checks/datacheck_meta/data_check_action_code.py similarity index 97% rename from checkers/data_checks/datacheck_meta/data_check_action_code.py rename to checkmates/data_checks/datacheck_meta/data_check_action_code.py index 53c7537..0106221 100644 --- a/checkers/data_checks/datacheck_meta/data_check_action_code.py +++ b/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): diff --git a/checkers/data_checks/datacheck_meta/data_check_action_option.py b/checkmates/data_checks/datacheck_meta/data_check_action_option.py similarity index 98% rename from checkers/data_checks/datacheck_meta/data_check_action_option.py rename to checkmates/data_checks/datacheck_meta/data_check_action_option.py index e50593c..ffaadd3 100644 --- a/checkers/data_checks/datacheck_meta/data_check_action_option.py +++ b/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: diff --git a/checkers/data_checks/datacheck_meta/data_check_message.py b/checkmates/data_checks/datacheck_meta/data_check_message.py similarity index 97% rename from checkers/data_checks/datacheck_meta/data_check_message.py rename to checkmates/data_checks/datacheck_meta/data_check_message.py index 454028e..d9f5138 100644 --- a/checkers/data_checks/datacheck_meta/data_check_message.py +++ b/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, ) diff --git a/checkers/data_checks/datacheck_meta/data_check_message_code.py b/checkmates/data_checks/datacheck_meta/data_check_message_code.py similarity index 100% rename from checkers/data_checks/datacheck_meta/data_check_message_code.py rename to checkmates/data_checks/datacheck_meta/data_check_message_code.py diff --git a/checkers/data_checks/datacheck_meta/data_check_message_type.py b/checkmates/data_checks/datacheck_meta/data_check_message_type.py similarity index 100% rename from checkers/data_checks/datacheck_meta/data_check_message_type.py rename to checkmates/data_checks/datacheck_meta/data_check_message_type.py diff --git a/checkers/data_checks/datacheck_meta/utils.py b/checkmates/data_checks/datacheck_meta/utils.py similarity index 94% rename from checkers/data_checks/datacheck_meta/utils.py rename to checkmates/data_checks/datacheck_meta/utils.py index 28a6873..3fa0416 100644 --- a/checkers/data_checks/datacheck_meta/utils.py +++ b/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, ) diff --git a/checkers/exceptions/__init__.py b/checkmates/exceptions/__init__.py similarity index 70% rename from checkers/exceptions/__init__.py rename to checkmates/exceptions/__init__.py index d6f2322..7c36414 100644 --- a/checkers/exceptions/__init__.py +++ b/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, diff --git a/checkers/exceptions/exceptions.py b/checkmates/exceptions/exceptions.py similarity index 100% rename from checkers/exceptions/exceptions.py rename to checkmates/exceptions/exceptions.py diff --git a/checkers/problem_types/__init__.py b/checkmates/problem_types/__init__.py similarity index 65% rename from checkers/problem_types/__init__.py rename to checkmates/problem_types/__init__.py index d7b5360..17c5404 100644 --- a/checkers/problem_types/__init__.py +++ b/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, diff --git a/checkers/problem_types/problem_types.py b/checkmates/problem_types/problem_types.py similarity index 97% rename from checkers/problem_types/problem_types.py rename to checkmates/problem_types/problem_types.py index 63b65d0..b7ff0ba 100644 --- a/checkers/problem_types/problem_types.py +++ b/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): diff --git a/checkers/problem_types/utils.py b/checkmates/problem_types/utils.py similarity index 98% rename from checkers/problem_types/utils.py rename to checkmates/problem_types/utils.py index 937ae37..9e7ec0c 100644 --- a/checkers/problem_types/utils.py +++ b/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): diff --git a/checkmates/utils/__init__.py b/checkmates/utils/__init__.py new file mode 100644 index 0000000..263a3ff --- /dev/null +++ b/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 diff --git a/checkers/utils/gen_utils.py b/checkmates/utils/gen_utils.py similarity index 100% rename from checkers/utils/gen_utils.py rename to checkmates/utils/gen_utils.py diff --git a/checkers/utils/woodwork_utils.py b/checkmates/utils/woodwork_utils.py similarity index 100% rename from checkers/utils/woodwork_utils.py rename to checkmates/utils/woodwork_utils.py diff --git a/contributing.md b/contributing.md index d44533a..e5474c6 100644 --- a/contributing.md +++ b/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 diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 6ef2fdb..723e99e 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -9,22 +9,22 @@ }}(); --> -Checkers - Alteryx Open Source Data Checks Library for Machine Learning - +CheckMates - Alteryx Open Source Data Checks Library for Machine Learning + - {% endblock %} @@ -37,7 +37,7 @@ Alteryx Open Source

- + GitHub @@ -46,7 +46,7 @@ Slack -
diff --git a/docs/source/conf.py b/docs/source/conf.py index 1d406ae..5cd7cc9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ from sphinx.domains.python import PythonDomain from sphinx.ext.autodoc import Documenter, MethodDocumenter -import checkers +import checkmates path = os.path.join("..", "..") sys.path.insert(0, os.path.abspath(path)) @@ -28,14 +28,14 @@ # -- Project information ----------------------------------------------------- -project = "Checkers" +project = "CheckMates" copyright = "2023, Alteryx, Inc." author = "Alteryx, Inc." # The short X.Y version -version = checkers.__version__ +version = checkmates.__version__ # The full version, including alpha/beta/rc tags -release = checkers.__version__ +release = checkmates.__version__ # -- General configuration --------------------------------------------------- @@ -114,7 +114,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/alteryx/Checkers", + "url": "https://github.com/alteryx/CheckMates", "icon": "fab fa-github-square", "type": "fontawesome", }, @@ -132,7 +132,7 @@ }, { "name": "StackOverflow", - "url": "https://stackoverflow.com/questions/tagged/checkers", + "url": "https://stackoverflow.com/questions/tagged/checkmates", "icon": "fab fa-stack-overflow", "type": "fontawesome", }, @@ -184,7 +184,7 @@ # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = "Checkersdoc" +htmlhelp_basename = "CheckMatesdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -208,7 +208,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, "Checkers.tex", "Checkers Documentation", author, "manual"), + (master_doc, "CheckMates.tex", "CheckMates Documentation", author, "manual"), ] @@ -216,7 +216,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "checkers", "Checkers Documentation", [author], 1)] +man_pages = [(master_doc, "checkmates", "CheckMates Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -227,10 +227,10 @@ texinfo_documents = [ ( master_doc, - "Checkers", - "Checkers Documentation", + "CheckMates", + "CheckMates Documentation", author, - "Checkers", + "CheckMates", "One line description of project.", "Miscellaneous", ), @@ -256,10 +256,10 @@ # -- Extension configuration ------------------------------------------------- -# If checkers is open-sourced: replace github specific style.css +# If checkmates is open-sourced: replace github specific style.css extlinks = { - "issue": ("https://github.com/alteryx/checkers/issues/%s", "#"), - "pr": ("https://github.com/alteryx/checkers/pull/%s", "#"), + "issue": ("https://github.com/alteryx/checkmates/issues/%s", "#"), + "pr": ("https://github.com/alteryx/checkmates/pull/%s", "#"), "user": ("https://github.com/%s", "@"), } @@ -282,7 +282,7 @@ class AccessorLevelDocumenter(Documenter): """ def resolve_name(self, modname, parents, path, base): - modname = "checkers" + modname = "checkmates" mod_cls = path.rstrip(".") mod_cls = mod_cls.split(".") return modname, mod_cls + [base] diff --git a/docs/source/index.ipynb b/docs/source/index.ipynb index d816396..c585288 100644 --- a/docs/source/index.ipynb +++ b/docs/source/index.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "![Checkers Logo](#)" + "![CheckMates Logo](#)" ] }, { @@ -13,7 +13,7 @@ "source": [ "# Home\n", "\n", - "Checkers is an AutoML library which catches and warns of problems with your data and problem setup before modeling." + "CheckMates is an AutoML library which catches and warns of problems with your data and problem setup before modeling." ] }, { diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index 25fa581..f8b0b30 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -28,8 +28,9 @@ Release Notes * Restructured file directory to categorize data checks between `datacheck_meta` and `checks` :pr:`1` * Restructured pdm packaging to only be relevant to `DataChecks`, now to be renamed to `CheckMate` :pr:`1` * Documentation Changes - * Documentation refactored to now fit `CheckMate` :pr:`2` + * Documentation refactored to now fit `CheckMates` :pr:`11` * Documentation refactored to now fit `Checkers` :pr:`4` + * Documentation refactored to now fit `CheckMate` :pr:`2` * Testing Changes * Automated testing within github actions :pr:`2` * Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1` diff --git a/docs/source/start.ipynb b/docs/source/start.ipynb index 402e7b1..baced75 100644 --- a/docs/source/start.ipynb +++ b/docs/source/start.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "In this guide, we'll show how you can use Checkers to automatically catch and warn of problems with your data and problem setup before modeling." + "In this guide, we'll show how you can use Checkmates to automatically catch and warn of problems with your data and problem setup before modeling." ] } ], diff --git a/docs/source/tutorials.ipynb b/docs/source/tutorials.ipynb index 7f3a771..63ad96c 100644 --- a/docs/source/tutorials.ipynb +++ b/docs/source/tutorials.ipynb @@ -6,7 +6,7 @@ "source": [ "# Tutorials\n", "\n", - "Below are examples of how to apply Checkers to a variety of problems:" + "Below are examples of how to apply CheckMates to a variety of problems:" ] } ], diff --git a/docs/source/user_guide.ipynb b/docs/source/user_guide.ipynb index 889a340..eccc6fd 100644 --- a/docs/source/user_guide.ipynb +++ b/docs/source/user_guide.ipynb @@ -6,7 +6,7 @@ "source": [ "# User Guide\n", "\n", - "These guides include in-depth descriptions and explanations of Checkers's features." + "These guides include in-depth descriptions and explanations of CheckMates's features." ] } ], diff --git a/pyproject.toml b/pyproject.toml index 318239b..5a205ca 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,13 @@ [project] -name = "Checkers" +name = "CheckMates" version = "0.1.0" -description = "Checkers is an AutoML library which catches and warns of problems with your data and problem setup before modeling." +description = "CheckMates is an AutoML library which catches and warns of problems with your data and problem setup before modeling." authors = [ - {name = "Nabil Fayak", email = "nabil.fayak@alteryx.com"}, + {name="Alteryx, Inc.", email="open_source_support@alteryx.com"} +] +maintainers = [ + {name="Alteryx, Inc.", email="open_source_support@alteryx.com"} ] dependencies = [ "numpy<=1.23.5,>=1.21.0", @@ -18,8 +21,8 @@ readme = "README.md" license = {text = "BSD-3-Clause"} [project.urls] -"Source Code"= "https://github.com/alteryx/Checkers/" -"Issue Tracker" = "https://github.com/alteryx/Checkers/issues" +"Source Code"= "https://github.com/alteryx/CheckMates/" +"Issue Tracker" = "https://github.com/alteryx/CheckMates/issues" [project.optional-dependencies] docs = [ @@ -88,13 +91,13 @@ ignore = ["E501", "D107", "D401"] "docs/**" = ["D"] [tool.ruff.isort] -known-first-party = ["checkers"] +known-first-party = ["checkmates"] [tool.ruff.pydocstyle] convention = "google" [tool.coverage.run] -source = ["checkers"] +source = ["checkmates"] [tool.coverage.report] exclude_lines =[ diff --git a/tests/data_checks_tests/test_data_check.py b/tests/data_checks_tests/test_data_check.py index d89240b..97444ef 100644 --- a/tests/data_checks_tests/test_data_check.py +++ b/tests/data_checks_tests/test_data_check.py @@ -1,8 +1,8 @@ import pandas as pd import pytest -from checkers.data_checks.checks.data_check import DataCheck -from checkers.data_checks.datacheck_meta.data_check_message import ( +from checkmates.data_checks.checks.data_check import DataCheck +from checkmates.data_checks.datacheck_meta.data_check_message import ( DataCheckError, DataCheckWarning, ) diff --git a/tests/data_checks_tests/test_data_check_action.py b/tests/data_checks_tests/test_data_check_action.py index 8790b15..40d0f3a 100644 --- a/tests/data_checks_tests/test_data_check_action.py +++ b/tests/data_checks_tests/test_data_check_action.py @@ -1,6 +1,6 @@ import pytest -from checkers.data_checks import DataCheckAction, DataCheckActionCode +from checkmates.data_checks import DataCheckAction, DataCheckActionCode def test_data_check_action_attributes(dummy_data_check_name): diff --git a/tests/data_checks_tests/test_data_check_action_option.py b/tests/data_checks_tests/test_data_check_action_option.py index d7d3842..93c2822 100644 --- a/tests/data_checks_tests/test_data_check_action_option.py +++ b/tests/data_checks_tests/test_data_check_action_option.py @@ -2,12 +2,12 @@ import pytest -from checkers.data_checks import ( +from checkmates.data_checks import ( DataCheckActionCode, DataCheckActionOption, DCAOParameterType, ) -from checkers.data_checks.datacheck_meta.data_check_action import DataCheckAction +from checkmates.data_checks.datacheck_meta.data_check_action import DataCheckAction def test_data_check_action_option_attributes(dummy_data_check_name): diff --git a/tests/data_checks_tests/test_data_check_message.py b/tests/data_checks_tests/test_data_check_message.py index 84d96b5..8503a08 100644 --- a/tests/data_checks_tests/test_data_check_message.py +++ b/tests/data_checks_tests/test_data_check_message.py @@ -1,6 +1,6 @@ import pytest -from checkers.data_checks import ( +from checkmates.data_checks import ( DataCheckActionCode, DataCheckActionOption, DataCheckError, diff --git a/tests/data_checks_tests/test_id_columns_data_check.py b/tests/data_checks_tests/test_id_columns_data_check.py index eda24ad..c7d27ee 100644 --- a/tests/data_checks_tests/test_id_columns_data_check.py +++ b/tests/data_checks_tests/test_id_columns_data_check.py @@ -2,7 +2,7 @@ import pandas as pd import pytest -from checkers.data_checks import ( +from checkmates.data_checks import ( DataCheckActionCode, DataCheckActionOption, DataCheckMessageCode, diff --git a/tests/data_checks_tests/test_utils.py b/tests/data_checks_tests/test_utils.py index 6dc8cf1..1055fc0 100644 --- a/tests/data_checks_tests/test_utils.py +++ b/tests/data_checks_tests/test_utils.py @@ -1,8 +1,8 @@ import pytest -from checkers.data_checks import DataCheckActionCode -from checkers.data_checks.datacheck_meta.utils import handle_data_check_action_code -from checkers.problem_types import ProblemTypes +from checkmates.data_checks import DataCheckActionCode +from checkmates.data_checks.datacheck_meta.utils import handle_data_check_action_code +from checkmates.problem_types import ProblemTypes def test_handle_action_code_errors():