Use black locally for formatting, document

Author: mdbenito

Makefile

@@ -37,15 +37,15 @@ endif
 	$(VENV_BIN)/python -m pytest -vv ./test
 
 lint: requirements  ## Apply autoformatting and linting rules
+	$(VENV_BIN)/black src_py test
 	$(VENV_BIN)/ruff check src_py test
-	$(VENV_BIN)/ruff format src_py test
 	-$(VENV_BIN)/mypy src_py test
 
 check: requirements
 	$(VENV_BIN)/ruff check src_py test --verbose
 
 format: requirements
-	$(VENV_BIN)/ruff format src_py test
+	$(VENV_BIN)/black src_py test
 
 CAPI_ENV_FILE=.cache/lbug-capi.env
 

README.md

@@ -53,3 +53,19 @@ Override the source tree location when needed:
 ```bash
 make build-pybind-subdir LBUG_SOURCE_DIR=/path/to/ladybug
 ```
+
+## Formatting
+
+Code is formatted with **black** and linted with **ruff**:
+
+```bash
+make lint        # black + ruff check + mypy
+make format      # black only
+make check       # ruff check only (verbose)
+```
+
+We also have a pre-commit hook for formatting and linting:
+
+```bash
+uv run --no-sync pre-commit install
+```

pyproject.toml

@@ -24,10 +24,12 @@ dev = [
     "pytest",
     "pytest-asyncio~=1.0",
     "setuptools~=80.9",
-    "ruff==0.11.12",
+    "black==26.3.0",
+    "ruff==0.15.18",
     "mypy==1.16.0",
     "torch>=2.5.0",
     "torch-geometric>=2.5.0",
+    "pre-commit>=4.6.0",
 ]
 
 [[tool.uv.index]]