Add repo revew to tephi (#164)

* added repo review

* added some ignores

* added some ignores

* noted which checks fail, and which skip

* added in show errskip

Co-authored-by: Martin Yeo <[email protected]>

* Added links to pyproj.toml

* fixed links

---------

Co-authored-by: Martin Yeo <[email protected]>

Author: ESadek-MO

.pre-commit-config.yaml

@@ -26,3 +26,10 @@ repos:
     -   id: flake8
         types: [file, python]
         args: [--config=./.flake8]
+
+-   repo: https://github.com/scientific-python/cookie
+    rev: 2024.08.19
+    hooks:
+    -   id: sp-repo-review
+        additional_dependencies: ["repo-review[cli]"]
+        args: ["--show=errskip"]

pyproject.toml

@@ -12,3 +12,49 @@ requires = [
 # Defined by PEP 517
 build-backend = "setuptools.build_meta"
 
+[tool.repo-review]
+# These are a list of the currently failing tests:
+ignore = [
+  # https://learn.scientific-python.org/development/guides/packaging-simple/#PY005
+  "PY005",  # Has tests folder
+
+  # https://learn.scientific-python.org/development/guides/packaging-classic/#PP003
+  "PP003",  # Does not list wheel as a build-dep
+  # https://learn.scientific-python.org/development/guides/pytest/#PP301
+  "PP301",  # Has pytest in project
+  # https://learn.scientific-python.org/development/guides/pytest/#PP304
+  "PP304",  # Sets the log level in pytest
+  # https://learn.scientific-python.org/development/guides/pytest/#PP305
+  "PP305",  # Specifies xfail_strict
+  # https://learn.scientific-python.org/development/guides/pytest/#PP306
+  "PP306",  # Specifies strict config
+  # https://learn.scientific-python.org/development/guides/pytest/#PP307
+  "PP307",  # Specifies strict markers
+  # https://learn.scientific-python.org/development/guides/pytest/#PP309
+  "PP309",  # Filter warnings specified
+
+  # https://learn.scientific-python.org/development/guides/gha-basic/#GH212
+  "GH212",  # Require GHA update grouping
+
+  # https://learn.scientific-python.org/development/guides/style/#PC110
+  "PC110",  # Uses black or ruff-format
+  # https://learn.scientific-python.org/development/guides/style/#PC140
+  "PC140",  # Uses a type checker
+  # https://learn.scientific-python.org/development/guides/style/#PC160
+  "PC160",  # Uses a spell checker
+  # https://learn.scientific-python.org/development/guides/style/#PC170
+  "PC170",  # Uses PyGrep hooks (only needed if rST present)
+  # https://learn.scientific-python.org/development/guides/style/#PC180
+  "PC180",  # Uses a markdown formatter
+  # https://learn.scientific-python.org/development/guides/style/#PC190
+  "PC190",  # Uses Ruff
+  # https://learn.scientific-python.org/development/guides/style/#PC901
+  "PC901",  # Custom pre-commit CI message
+
+  # https://learn.scientific-python.org/development/guides/style/#MY100
+  "MY100",  # Uses MyPy (pyproject config)
+
+  # https://learn.scientific-python.org/development/guides/style/#RF001
+  "RF001",  # Has Ruff config
+]
+