Add pre-commit configuration

.github/workflows/pytest.yaml

@@ -134,3 +134,13 @@ jobs:
 
     - name: Upload test coverage to Codecov.io
       uses: codecov/codecov-action@v3
+
+  pre-commit:
+    name: Code quality
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+    - uses: pre-commit/[email protected]

.gitignore

@@ -50,8 +50,9 @@ rixmp/source/inst/docum/*.html
 # pytest and related
 .benchmarks
 .coverage*
-.pytest_cache
 .mypy_cache
+.pytest_cache
+.ruff_cache
 *.pid
 coverage.xml
 htmlcov

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: local
+  hooks:
+  - id: mypy
+    name: mypy
+    always_run: true
+    require_serial: true
+    pass_filenames: false
+
+    language: python
+    entry: bash -c ". ${PRE_COMMIT_MYPY_VENV:-/dev/null}/bin/activate 2>/dev/null; mypy $0 $@"
+    additional_dependencies:
+    - mypy
+    - genno
+    - GitPython
+    - nbclient
+    - pytest
+    - sphinx
+    - xarray
+    args: ["."]
+- repo: https://github.com/psf/black
+  rev: 23.7.0
+  hooks:
+  - id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.287
+  hooks:
+  - id: ruff

pyproject.toml

@@ -5,12 +5,10 @@ requires = ["build", "setuptools-scm"]
 dynamic = ["version"]
 name = "ixmp"
 description = "The ix modeling platform"
-authors = [
-  { name = "IIASA Energy, Climate, and Environment (ECE) program" },
-]
+authors = [{ name = "IIASA Energy, Climate, and Environment (ECE) program" }]
 maintainers = [
-  {name = "Paul Natsuo Kishimoto", email = "[email protected]"},
-  {name = "Fridolin Glatter", email = "[email protected]"},
+  { name = "Paul Natsuo Kishimoto", email = "[email protected]" },
+  { name = "Fridolin Glatter", email = "[email protected]" },
 ]
 readme = "README.md"
 classifiers = [
@@ -75,9 +73,7 @@ tests = [
 ixmp = "ixmp.cli:main"
 
 [tool.coverage.report]
-omit = [
-  "ixmp/utils/sphinx_linkcode_github.py",
-]
+omit = ["ixmp/utils/sphinx_linkcode_github.py"]
 
 [tool.isort]
 profile = "black"
@@ -112,6 +108,16 @@ markers = [
   "performance: ixmp performance test.",
 ]
 
+[tool.ruff]
+select = ["C9", "E", "F", "I", "W"]
+
+[tool.ruff.mccabe]
+# FIXME the following exceed this limit
+# .backend.io.s_read_excel: 26
+# .backend.jdbc.JDBCBackend.item_get_elements: 19
+# .core.scenario.Scenario.add_set: 17
+max-complexity = 15
+
 [tool.setuptools.packages]
 find = {}