From 2928fc5514aee657c01031907322f1d046913d0d Mon Sep 17 00:00:00 2001
From: Mitchell <120224887+Mitchell-Medeiros@users.noreply.github.com>
Date: Wed, 31 Jul 2024 12:20:32 +0300
Subject: [PATCH] Added codecov report to github action for unit tests.
 Supressed deprecation warnings internal to the kaggle library in tests.
 Updated badges in readme.

---
 .github/workflows/unit-tests.yml |  7 ++++++-
 .gitignore                       |  2 ++
 README.md                        | 23 ++++++++++++-----------
 pyproject.toml                   |  2 ++
 tests/.coveragerc                |  4 ++++
 5 files changed, 26 insertions(+), 12 deletions(-)
 create mode 100644 tests/.coveragerc

diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
index ef68ad6..4b7c154 100644
--- a/.github/workflows/unit-tests.yml
+++ b/.github/workflows/unit-tests.yml
@@ -52,4 +52,9 @@ jobs:
 
     - name: Run tests
       working-directory: ./tests
-      run: pytest
+      run: pytest --cov . --cov-config=.coveragerc
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v4.0.1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 9fe1518..5e2e4a7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,3 +42,5 @@ tests/data/test.*
 .DS_Store
 .env
 .pypirc
+.coverage
+.coverage.*
diff --git a/README.md b/README.md
index 15e2e5a..e582073 100644
--- a/README.md
+++ b/README.md
@@ -5,25 +5,26 @@
 <div align="center">
 <a href="https://pypi.org/project/mlcompare">
     <img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/mlcompare?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxLjAxZW0iIGhlaWdodD0iMWVtIiB2aWV3Qm94PSIwIDAgMjU2IDI1NSI%2BPGRlZnM%2BPGxpbmVhckdyYWRpZW50IGlkPSJsb2dvc1B5dGhvbjAiIHgxPSIxMi45NTklIiB4Mj0iNzkuNjM5JSIgeTE9IjEyLjAzOSUiIHkyPSI3OC4yMDElIj48c3RvcCBvZmZzZXQ9IjAlIiBzdG9wLWNvbG9yPSIjMzg3ZWI4Ii8%2BPHN0b3Agb2Zmc2V0PSIxMDAlIiBzdG9wLWNvbG9yPSIjMzY2OTk0Ii8%2BPC9saW5lYXJHcmFkaWVudD48bGluZWFyR3JhZGllbnQgaWQ9ImxvZ29zUHl0aG9uMSIgeDE9IjE5LjEyOCUiIHgyPSI5MC43NDIlIiB5MT0iMjAuNTc5JSIgeTI9Ijg4LjQyOSUiPjxzdG9wIG9mZnNldD0iMCUiIHN0b3AtY29sb3I9IiNmZmUwNTIiLz48c3RvcCBvZmZzZXQ9IjEwMCUiIHN0b3AtY29sb3I9IiNmZmMzMzEiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48cGF0aCBmaWxsPSJ1cmwoI2xvZ29zUHl0aG9uMCkiIGQ9Ik0xMjYuOTE2LjA3MmMtNjQuODMyIDAtNjAuNzg0IDI4LjExNS02MC43ODQgMjguMTE1bC4wNzIgMjkuMTI4aDYxLjg2OHY4Ljc0NUg0MS42MzFTLjE0NSA2MS4zNTUuMTQ1IDEyNi43N2MwIDY1LjQxNyAzNi4yMSA2My4wOTcgMzYuMjEgNjMuMDk3aDIxLjYxdi0zMC4zNTZzLTEuMTY1LTM2LjIxIDM1LjYzMi0zNi4yMWg2MS4zNjJzMzQuNDc1LjU1NyAzNC40NzUtMzMuMzE5VjMzLjk3UzE5NC42Ny4wNzIgMTI2LjkxNi4wNzJNOTIuODAyIDE5LjY2YTExLjEyIDExLjEyIDAgMCAxIDExLjEzIDExLjEzYTExLjEyIDExLjEyIDAgMCAxLTExLjEzIDExLjEzYTExLjEyIDExLjEyIDAgMCAxLTExLjEzLTExLjEzYTExLjEyIDExLjEyIDAgMCAxIDExLjEzLTExLjEzIi8%2BPHBhdGggZmlsbD0idXJsKCNsb2dvc1B5dGhvbjEpIiBkPSJNMTI4Ljc1NyAyNTQuMTI2YzY0LjgzMiAwIDYwLjc4NC0yOC4xMTUgNjAuNzg0LTI4LjExNWwtLjA3Mi0yOS4xMjdIMTI3LjZ2LTguNzQ1aDg2LjQ0MXM0MS40ODYgNC43MDUgNDEuNDg2LTYwLjcxMmMwLTY1LjQxNi0zNi4yMS02My4wOTYtMzYuMjEtNjMuMDk2aC0yMS42MXYzMC4zNTVzMS4xNjUgMzYuMjEtMzUuNjMyIDM2LjIxaC02MS4zNjJzLTM0LjQ3NS0uNTU3LTM0LjQ3NSAzMy4zMnY1Ni4wMTNzLTUuMjM1IDMzLjg5NyA2Mi41MTggMzMuODk3bTM0LjExNC0xOS41ODZhMTEuMTIgMTEuMTIgMCAwIDEtMTEuMTMtMTEuMTNhMTEuMTIgMTEuMTIgMCAwIDEgMTEuMTMtMTEuMTMxYTExLjEyIDExLjEyIDAgMCAxIDExLjEzIDExLjEzYTExLjEyIDExLjEyIDAgMCAxLTExLjEzIDExLjEzIi8%2BPC9zdmc%2B&labelColor=blue&color=yellow">
-</a>
+</a>&nbsp;
 <a href="https://pypi.org/project/mlcompare/">
     <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/mlcompare?logo=pypi&label=PyPi&labelColor=white&color=blue">
-</a>
+</a>&nbsp;
 <a href="https://pypi.org/project/mlcompare/">
     <img alt="PyPI - License" src="https://img.shields.io/pypi/l/mlcompare?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iMWVtIiB2aWV3Qm94PSIwIDAgMTYgMTYiPjxwYXRoIGZpbGw9Im5vbmUiIHN0cm9rZT0iIzk3OTc5NyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBkPSJNNC41IDEzLjVoN004LjAxIDF2MTIuMDZNMS41IDMuNWgzbDEuNS0xaDRsMS41IDFoM00uNSAxMEwzIDQuNDhMNS41IDEwQzQgMTEgMiAxMSAuNSAxMG0xMCAwTDEzIDQuNDhMMTUuNSAxMGMtMS41IDEtMy41IDEtNSAwIi8%2BPC9zdmc%2B&labelColor=darkred&color=lightgrey">
 </a>
+
+<a href="https://mlcompare.readthedocs.io/en/latest/api_reference">
+    <img alt="Read the Docs" src="https://img.shields.io/readthedocs/mlcompare?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNTYiIGhlaWdodD0iMjU2IiB2aWV3Qm94PSIwIDAgNDggNDgiPjxwYXRoIGZpbGw9IiM5MGNhZjkiIGQ9Ik00MCA0NUg4VjNoMjJsMTAgMTB6Ii8%2BPHBhdGggZmlsbD0iI2UxZjVmZSIgZD0iTTM4LjUgMTRIMjlWNC41eiIvPjxwYXRoIGZpbGw9IiMxOTc2ZDIiIGQ9Ik0xNiAyMWgxN3YySDE2em0wIDRoMTN2MkgxNnptMCA0aDE3djJIMTZ6bTAgNGgxM3YySDE2eiIvPjwvc3ZnPg%3D%3D&labelColor=white">
+</a>&nbsp;
 <a href="https://github.com/MitchMedeiros/MLCompare/actions/workflows/lint.yml">
-    <img alt="GitHub Actions build status (Lint)" src="https://github.com/MitchMedeiros/MLCompare/workflows/Lint/badge.svg">
-</a>
+    <img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/MitchMedeiros/MLCompare/lint.yml?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNTYiIGhlaWdodD0iMjU2IiB2aWV3Qm94PSIwIDAgMjQgMjQiPjxwYXRoIGZpbGw9IiNlMzI0MDAiIGQ9Im0xMS4wNzUgMTQuOTVsMS44NS0yLjUyNWwxLjgyNSAyLjUyNUwxOCAxMC41MjVMMTYuNCA5LjM1bC0xLjY1IDIuMjI1TDEyLjkgOS4wNWwtMS44MjUgMi41MjVsLTEuODUtMi41MjVMNiAxMy40NzVsMS42IDEuMTc1bDEuNjI1LTIuMjI1ek0xMiAyMnEtMi4wNzUgMC0zLjktLjc4OHQtMy4xNzUtMi4xMzdUMi43ODggMTUuOVQyIDEydC43ODgtMy45dDIuMTM3LTMuMTc1VDguMSAyLjc4OFQxMiAydDMuOS43ODh0My4xNzUgMi4xMzdUMjEuMjEzIDguMVQyMiAxMnQtLjc4OCAzLjl0LTIuMTM3IDMuMTc1dC0zLjE3NSAyLjEzOFQxMiAyMm0wLTJxMy4zNSAwIDUuNjc1LTIuMzI1VDIwIDEydC0yLjMyNS01LjY3NVQxMiA0VDYuMzI1IDYuMzI1VDQgMTJ0Mi4zMjUgNS42NzVUMTIgMjBtMC04Ii8%2BPC9zdmc%2B&label=Lint&labelColor=lightgreen">
+</a>&nbsp;
 <a href="https://github.com/MitchMedeiros/MLCompare/actions/workflows/unit-tests.yml">
-    <img alt="GitHub Actions build status (MacOS Unit Tests)" src="https://github.com/MitchMedeiros/MLCompare/actions/workflows/unit-tests.yml/badge.svg">
-</a>
-<!-- <a href="https://app.codecov.io/gh/MitchMedeiros/MLCompare">
-    <img alt="Code coverage" src="https://codecov.io/gh/MitchMedeiros/MLCompare/branch/main/graph/badge.svg">
+    <img alt="GitHub Actions status (MacOS Unit Tests)" src="https://img.shields.io/github/actions/workflow/status/MitchMedeiros/MLCompare/unit-tests.yml?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iMWVtIiB2aWV3Qm94PSIwIDAgMTI4IDEyOCI%2BPHBhdGggZmlsbD0iIzY5Njk2OSIgZD0iTTMxLjUxMiAzMC4zOThoNjEuMzA0YTMuMDA2IDMuMDA2IDAgMCAxIDAgNi4wMTJIMzEuNTEyYTMuMDA3IDMuMDA3IDAgMCAxLTMuMDA0LTMuMDA0YTMuMDEgMy4wMSAwIDAgMSAzLjAwNC0zLjAwOG0wIDAiLz48cGF0aCBmaWxsPSIjMDA5ZmUzIiBkPSJNMzIuMDQ3IDI0LjMySDQ0LjM3djIuODQ0SDMyLjA0N3ptMCAwIi8%2BPHBhdGggZmlsbD0iI2M3ZDMwMiIgZD0iTTQ4LjE2OCAyNC4zMmgxMi4zMjR2Mi44NDRINDguMTY4em0wIDAiLz48cGF0aCBmaWxsPSIjZjA3ZTE2IiBkPSJNNjQuMDcgMjQuMzJoMTIuMzI4djIuODQ0SDY0LjA3em0wIDAiLz48cGF0aCBmaWxsPSIjZGYyODE1IiBkPSJNNzkuOTEgMjQuMzJoMTIuMzI0djIuODQ0SDc5Ljkxem0wIDE1LjIyaDEyLjMyNHYyMC44MzVINzkuOTF6bTAgMCIvPjxwYXRoIGZpbGw9IiNmMDdlMTYiIGQ9Ik02NC4wNyAzOS41NGgxMi4zNTJ2MzMuODQ3SDY0LjA3em0wIDAiLz48cGF0aCBmaWxsPSIjYzdkMzAyIiBkPSJNNDguMTY4IDM5LjU0aDEyLjMyNHY1MC42OThINDguMTY4em0wIDAiLz48cGF0aCBmaWxsPSIjMDA5ZmUzIiBkPSJNMzIuMDQ3IDM5LjU0SDQ0LjM3djYxLjc5MkgzMi4wNDd6bTAgMCIvPjwvc3ZnPg%3D%3D&label=Unit%20Tests&labelColor=darkgreen">
+</a>&nbsp;
+<a href="https://app.codecov.io/gh/MitchMedeiros/MLCompare">
+    <img alt="Code Coverage" src="https://img.shields.io/codecov/c/github/MitchMedeiros/MLCopmare?logo=codecov">
 </a>
-<a href="https://mlcompare.readthedocs.io">
-    <img alt="Read the Docs" src="https://img.shields.io/badge/Docs-%20?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iMWVtIiB2aWV3Qm94PSIwIDAgNTEyIDUxMiI%2BPHBhdGggZmlsbD0iI2Y5ZTdjMCIgZD0iTTQzNy41NjcgNTEySDg4LjAwNGE4LjE4MiA4LjE4MiAwIDAgMS04LjE4Mi04LjE4MlY4LjE4MkE4LjE4MiA4LjE4MiAwIDAgMSA4OC4wMDQgMEgyODguNzlsMTU2Ljk2IDE1Ni45NnYzNDYuODU4YTguMTgzIDguMTgzIDAgMCAxLTguMTgzIDguMTgyIi8%2BPHBhdGggZmlsbD0iI2VhYzA4MyIgZD0ibTI4OC43OSAwbDE1Ni45NiAxNTYuOTZIMzIyLjE1MmMtMTguNDI2IDAtMzMuMzYzLTE0LjkzNy0zMy4zNjMtMzMuMzYzVjB6Ii8%2BPHBhdGggZmlsbD0iIzU5N2I5MSIgZD0iTTIzNS4wNzggOTIuNDAxSDEyNi40NTNjLTYuMTQ3IDAtMTEuMTMtNC45ODMtMTEuMTMtMTEuMTNzNC45ODMtMTEuMTMgMTEuMTMtMTEuMTNoMTA4LjYyNWM2LjE0NyAwIDExLjEzIDQuOTgzIDExLjEzIDExLjEzcy00Ljk4MyAxMS4xMy0xMS4xMyAxMS4xM20xMS4xMyA2MS43MjNjMC02LjE0Ny00Ljk4My0xMS4xMy0xMS4xMy0xMS4xM0gxMjYuNDUzYy02LjE0NyAwLTExLjEzIDQuOTgzLTExLjEzIDExLjEzczQuOTgzIDExLjEzIDExLjEzIDExLjEzaDEwOC42MjVjNi4xNDcgMCAxMS4xMy00Ljk4MyAxMS4xMy0xMS4xM20wIDcyLjg1NGMwLTYuMTQ3LTQuOTgzLTExLjEzLTExLjEzLTExLjEzSDEyNi40NTNjLTYuMTQ3IDAtMTEuMTMgNC45ODMtMTEuMTMgMTEuMTNzNC45ODMgMTEuMTMgMTEuMTMgMTEuMTNoMTA4LjYyNWM2LjE0Ny0uMDAxIDExLjEzLTQuOTgzIDExLjEzLTExLjEzbTk0LjAzOCA3Mi44NTNjMC02LjE0Ni00Ljk4My0xMS4xMy0xMS4xMy0xMS4xM0gxMjYuNDUzYy02LjE0NyAwLTExLjEzIDQuOTgzLTExLjEzIDExLjEzczQuOTgzIDExLjEzIDExLjEzIDExLjEzaDIwMi42NjNjNi4xNDcgMCAxMS4xMy00Ljk4MyAxMS4xMy0xMS4xM20zNy40OTMtNzIuODUzYzAtNi4xNDctNC45ODMtMTEuMTMtMTEuMTMtMTEuMTNoLTc0Ljk4NWMtNi4xNDYgMC0xMS4xMyA0Ljk4My0xMS4xMyAxMS4xM3M0Ljk4MyAxMS4xMyAxMS4xMyAxMS4xM2g3NC45ODVjNi4xNDctLjAwMSAxMS4xMy00Ljk4MyAxMS4xMy0xMS4xM00yOTkuOTIgMzcyLjY4NWMwLTYuMTQ2LTQuOTgzLTExLjEzLTExLjEzLTExLjEzSDEyNi40NTNjLTYuMTQ3IDAtMTEuMTMgNC45ODMtMTEuMTMgMTEuMTNzNC45ODMgMTEuMTMgMTEuMTMgMTEuMTNIMjg4Ljc5YzYuMTQ3LS4wMDEgMTEuMTMtNC45ODQgMTEuMTMtMTEuMTNtNjYuMjEgNzIuODUzYzAtNi4xNDYtNC45ODMtMTEuMTMtMTEuMTMtMTEuMTNIMTI2LjQ1M2MtNi4xNDcgMC0xMS4xMyA0Ljk4My0xMS4xMyAxMS4xM3M0Ljk4MyAxMS4xMyAxMS4xMyAxMS4xM0gzNTVjNi4xNDYgMCAxMS4xMy00Ljk4MyAxMS4xMy0xMS4xMyIvPjwvc3ZnPg%3D%3D&labelColor=teal">
-</a> -->
 </div>
 
 <br>
diff --git a/pyproject.toml b/pyproject.toml
index 2055728..453eca6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -45,6 +45,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "pytest>=8.0.0",
+    "pytest-cov>=5.0.0",
     "black>=24.0.0",
     "ruff>=0.5.0",
     "ipykernel>=6.0.0",
@@ -72,6 +73,7 @@ packages = ["mlcompare"]
 [tool.pytest.ini_options]
 testpaths = "tests"
 xfail_strict = true
+filterwarnings = ["ignore::DeprecationWarning:kaggle.rest"]
 
 [tool.ruff]
 line-length = 99
diff --git a/tests/.coveragerc b/tests/.coveragerc
new file mode 100644
index 0000000..dfaa523
--- /dev/null
+++ b/tests/.coveragerc
@@ -0,0 +1,4 @@
+[run]
+omit =
+    ./conftest.py
+    ./testing.py