style: use ruff for formatting/linting

.github/workflows/checks.yaml

@@ -19,3 +19,17 @@ jobs:
         run: |
           python -m pip install pipenv
           pipenv install --skip-lock  # this is what Elastic beanstalk uses
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+
+      - name: Install dependencies
+        run: python3 -m pip install '.[dev]'
+
+      - name: Check style
+        run: python3 -m ruff check . && ruff format --check .

.pre-commit-config.yaml

@@ -1,12 +1,16 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.4.0
     hooks:
-    - id: flake8
-      additional_dependencies: [flake8-docstrings]
-    - id: check-added-large-files
-      args: ['--maxkb=1024']
-      exclude: ^tests/data
-    - id: detect-private-key
+      - id: check-added-large-files
+        args: ['--maxkb=1024']
+        exclude: ^tests/data
+      - id: detect-private-key
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.14
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]

pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+src = ["metakb"]
+# pycodestyle (E, W)
+# Pyflakes (F)
+# flake8-annotations (ANN)
+# pydocstyle (D)
+# pep8-naming (N)
+# isort (I)
+select = ["E", "W", "F", "ANN", "D", "N", "I"]
+fixable = ["I", "F401"]
+
+# ANN101 - missing-type-self
+# ANN003 - missing-type-kwargs
+# D203 - one-blank-line-before-class
+# D205 - blank-line-after-summary
+# D206 - indent-with-spaces*
+# D213 - multi-line-summary-second-line
+# D300 - triple-single-quotes*
+# D400 - ends-in-period
+# D415 - ends-in-punctuation
+# E111 - indentation-with-invalid-multiple*
+# E114 - indentation-with-invalid-multiple-comment*
+# E117 - over-indented*
+# E501 - line-too-long*
+# W191 - tab-indentation*
+# *ignored for compatibility with formatter
+ignore = [
+    "ANN101", "ANN003",
+    "D203", "D205", "D206", "D213", "D300", "D400", "D415",
+    "E111", "E114", "E117", "E501",
+    "W191"
+]
+
+[tool.ruff.per-file-ignores]
+# ANN001 - missing-type-function-argument
+# ANN2 - missing-return-type
+# ANN201 - Missing type annotation
+# ANN102 - missing-type-cls
+# N805 - invalid-first-argument-name-for-method
+"tests/*" = ["ANN001", "ANN102", "ANN2"]
+"metakb/schemas.py" = ["ANN001", "ANN201", "N805"]

setup.cfg

@@ -45,9 +45,8 @@ install_requires =
 [options.extras_require]
 dev =
     pre-commit
-    flake8
-    flake8-docstrings
     ipykernel
+    ruff >= 0.1.14
 
 tests =
     pytest