Add ruff support

Add a dedicated ruff.toml file for configuring ruff
markusritschel · Aug 16, 2024 · 021d90c · 021d90c
1 parent 513db26
commit 021d90c
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/{{ cookiecutter.project_slug }}/environment.yml b/{{ cookiecutter.project_slug }}/environment.yml
@@ -24,6 +24,7 @@ dependencies:
   - pandas
   - pytest
   - python-dotenv
+  - ruff
   - tqdm
   - xarray
   - pip
diff --git a/{{ cookiecutter.project_slug }}/requirements.txt b/{{ cookiecutter.project_slug }}/requirements.txt
@@ -6,3 +6,4 @@ click
 {% endif %}
 pytest
 pytest-cov
+ruff
diff --git a/{{ cookiecutter.project_slug }}/ruff.toml b/{{ cookiecutter.project_slug }}/ruff.toml
@@ -0,0 +1,29 @@
+# See https://docs.astral.sh/ruff/ for settings
+line-length = 88
+indent-width = 4
+
+
+[format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = false
+
+
+[lint]
+extend-select = [
+  # pydocstyle
+  "D",
+  # pycodestyle
+  "E",
+  # Pyflakes
+  "F",
+]
+
+ignore = ["F403", "F405"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+
+[lint.pydocstyle]
+convention = "numpy"
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,7 @@ dependencies: @@
       - pandas
       - pytest
       - python-dotenv
+      - ruff
       - tqdm
       - xarray
       - pip