Adding ruff to ci.yml (#21)

* added ruff in pyproject.toml & ci.yml * removed comments in ci.yml and pyproject.toml
talmolab · Sep 26, 2023 · 11a1a33 · 11a1a33
1 parent 47897ad
commit 11a1a33
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -55,9 +55,9 @@ jobs:
       run: |
         black --check sleap_nn tests
 
-    - name: Run pydocstyle
+    - name: Run ruff
       run: |
-        pydocstyle --convention=google sleap_nn/
+        ruff check sleap_nn/
 
   # Tests with pytest
   tests:

diff --git a/pyproject.toml b/pyproject.toml
@@ -43,7 +43,8 @@ dev = [
     "toml",
     "twine",
     "build",
-    "ipython"
+    "ipython",
+    "ruff"
 ]
 
 [project.scripts]
@@ -56,6 +57,12 @@ Repository = "https://github.com/talmolab/sleap-nn"
 [tool.black]
 line-length = 88
 
-[pydocstyle]
+[tool.ruff]
+format = "github"
+select = [
+    "D",  # pydocstyle
+]
+target-version = "py39"
+
+[tool.ruff.pydocstyle]
 convention = "google"
-match-dir = "sleap_nn"