Configure black & ruff with pre-commit

Author: mfisher87

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+  - repo: "https://github.com/charliermarsh/ruff-pre-commit"
+    rev: "v0.0.269"
+    hooks:
+      - id: "ruff"
+        args: ["--fix", "--exit-non-zero-on-fix"]
+
+  - repo: "https://github.com/psf/black"
+    rev: "23.3.0"
+    hooks:
+      - id: "black"

doc/contributing.md

@@ -21,3 +21,17 @@ rm -rf dist
 python -m build
 pip install dist/*.whl  # or `dist/*.tar.gz`
 ```
+
+
+## Code formatting and linting
+
+This codebase uses [black](https://black.readthedocs.io/en/stable/) and
+[ruff](https://github.com/charliermarsh/ruff) to automatically format and lint the code.
+
+[`pre-commit`](https://pre-commit.com/) is configured to run them automatically. You can
+trigger this manually with `pre-commit run --all-files`.
+
+Thanks to pre-commit, all commits should be formatted. In cases where formatting needs
+to be fixed (e.g. changing config of a linter), a format-only commit should be created,
+and then another commit should immediately follow which updates
+`.git-blame-ignore-revs`.

environment.yml

@@ -3,10 +3,15 @@ channels:
   - "conda-forge"
   - "nodefaults"
 dependencies:
+  # Runtime
   - "python ~=3.11"
   - "numpy ~=1.24"
   - "matplotlib ~=3.7"
   - "colorspacious ~=1.1"
   - "scipy ~=1.10"
+
+  # Development
+  - "pre-commit"
+
   - pip:
     - "build ~=0.10"

pyproject.toml

@@ -45,4 +45,12 @@ packages = {find = {}}
 package-data = {viscm = ["examples/*"]}
 
 
-# [tool.black]
+[tool.black]
+target-version = ["py37", "py38", "py39", "py310", "py311"]
+
+[tool.ruff]
+target-version = "py37"
+select = ["F", "E", "W", "C90", "I", "UP", "YTT", "B", "A", "C4", "T10", "RUF"]
+
+[tool.ruff.mccabe]
+max-complexity = 11