diff --git a/.gitignore b/.gitignore index 3f97087..3a149bd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ .venv/ **/__pycache__/ .DS_Store -Checkers.egg-info/ \ No newline at end of file +Checkers.egg-info/ +.python-version +pdm.lock \ No newline at end of file diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index 6a22f71..25fa581 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -1,13 +1,38 @@ Release Notes ------------- -**Future Releases** - * Enhancements - * Fixes - * Cleanup files and add release workflow :pr:`6` - * Changes - * Documentation Changes - * Testing Changes +.. **Future Releases** +.. * Enhancements +.. * Fixes +.. * Changes +.. * Documentation Changes +.. * Testing Changes +**v0.1.0 July 28, 2023** +* Enhancements + * updated pyproject to v0.1.0 for first release and added project urls :pr:`8` + * added pdm.lock and .python-version to .gitignore :pr:`8` + * Added repo specific token for workflows :pr:`2` + * PDM Packaging ready for deployment :pr:`2` + * Added testing workflow for pytest :pr:`2` + * Transfer over base `Data Checks` and `IDColumnData Checks` from the `EvalML` repo :pr:`1` + * Added in github workflows that are relevant to `DataChecks`, from `EvalML` repository, and modified to fit `DataChecks` wherever possible :pr:`1` + * Implemented linters and have them successfully running :pr:`1` +* Fixes + * Cleanup files and add release workflow :pr:`6` + * Fixed pytest failures :pr:`1` + * Workflows are now up and running properly :pr:`1` +* Changes + * Irrelevant workflows removed (`minimum_dependency_checker`) :pr:`2` + * Removed all `EvalML` dependencies and unnecessary functions/comments from `utils`, `tests`, `exceptions`, and `datachecks` :pr:`1` + * Updated comments to reflect `DataChecks` repository :pr:`1` + * 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 `Checkers` :pr:`4` +* Testing Changes + * Automated testing within github actions :pr:`2` + * Removed integration testing due to irrelevance with `datacheck_meta` and `checks` :pr:`1` **v0.0.2 July 26, 2023** * Enhancements @@ -41,4 +66,4 @@ Release Notes **v0.0.0 July 3, 2023** -* *First Release* +* *GitHub Repo Created* diff --git a/pyproject.toml b/pyproject.toml index f3536d8..318239b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "Checkers" -version = "0.0.2" +version = "0.1.0" description = "Checkers 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"}, @@ -17,6 +17,10 @@ requires-python = ">=3.8,<4.0" 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" + [project.optional-dependencies] docs = [ "docutils<0.17,>=0.15.2",