ci: migrate to uv + tox based setup🔧

KarelZe · Nov 24, 2024 · 7da9806 · 7da9806
1 parent 18b7f52
commit 7da9806
Show file tree

Hide file tree

Showing 5 changed files with 260 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ pip install tclf
 
 **[uv⚡](https://github.com/astral-sh/uv)**
 ```console
-uv pip install tclf
+uv add tclf
 ```
 
 ## Supported Algorithms

diff --git a/docs/index.md b/docs/index.md
@@ -27,7 +27,7 @@ pip install tclf
 
 **[uv⚡](https://github.com/astral-sh/uv)**
 ```console
-uv pip install tclf
+uv add tclf
 ```
 
 ## Supported Algorithms

diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,8 @@ classifiers = [
 dependencies = [
   "numpy",
   "pandas",
-  "scikit-learn"
+  "ruff>=0.8.0",
+  "scikit-learn",
 ]
 dynamic = ["version"]
 
@@ -99,6 +100,7 @@ include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
 select = [
     "C",    # flake8-comprehensions
     "D",    # pydocstyle
+    "DOC",  # pydoclint
     "E",    # pycodestyle errors
     "F",    # pyflakes
     "FURB", # refurb

diff --git a/src/tclf/classical_classifier.py b/src/tclf/classical_classifier.py
@@ -106,6 +106,9 @@ def _more_tags(self) -> dict[str, bool | dict[str, str]]:
         """Set tags for sklearn.
 
         See: https://scikit-learn.org/stable/developers/develop.html#estimator-tags
+
+        Returns:
+            dict[str, bool | dict[str, str]]: dict with tags
         """
         return {
             "allow_nan": True,
@@ -213,6 +216,7 @@ def _mid(self, subset: str) -> npt.NDArray:
         Args:
             subset (str): subset i.e.,
             'ex' or 'best'
+
         Returns:
             npt.NDArray: midpoints. Can be np.NaN.
         """