Add Ruff for linting and formatting (#118).

Replace flake8 with ruff in CI, Makefile, and requirements, and document the 88-character line length convention.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: holybiber

.editorconfig

@@ -10,6 +10,7 @@ trim_trailing_whitespace = true
 [*.py]
 indent_style = space
 indent_size = 4
+max_line_length = 88
 
 [Makefile]
 indent_style = tab

.github/workflows/main.yml

@@ -40,7 +40,7 @@ jobs:
         uses: codecov/codecov-action@v2
 
   python-code-quality:
-    # Run flake8 for linting
+    # Run ruff for linting and formatting
     runs-on: ubuntu-latest
 
     steps:
@@ -50,5 +50,7 @@ jobs:
       - name: Install python packages
         run: pip install -r requirements.txt
 
-      - name: Run flake8
-        run: flake8 .
+      - name: Run ruff
+        run: |
+          ruff check .
+          ruff format --check .

CONTRIBUTING.md

@@ -48,10 +48,11 @@ Ready to contribute? Here's how to set up `pywikitools` for local development.
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that all tests are passing and that
-   `flake8` has nothing to complain:
+5. When you're done making changes, run `make format` and check that all tests
+   are passing and that `make lint` has nothing to complain:
 
    ```shell
+   $ make format
    $ make test
    $ make lint
    ```
@@ -70,7 +71,7 @@ Ready to contribute? Here's how to set up `pywikitools` for local development.
 
 * Please write good and readable code with meaningful documentation.
 * We do our best to follow the PEP 8 style guide ([PEP 8](https://pep8.org/))
-  with the exception that lines can have up to `120 characters`.
+  with a maximum line length of `88 characters` (enforced by Ruff).
 * Every script should print documentation on arguments when run without or with
   incorrect arguments.
 

Makefile

@@ -1,9 +1,9 @@
-.PHONY: help test lint coverage clean clean-pyc clean-test
+.PHONY: help test lint format coverage clean clean-pyc clean-test
 
 .DEFAULT_GOAL := help
 
 PYTHON ?= ./env/bin/python
-FLAKE8 ?= ./env/bin/flake8
+RUFF ?= ./env/bin/ruff
 COVERAGE ?= ./env/bin/coverage
 
 define BROWSER_PYSCRIPT
@@ -34,8 +34,12 @@ help: ## show this help
 test: ## run the test suite
 	$(PYTHON) -m unittest discover -s pywikitools/test
 
-lint: ## check style with flake8
-	$(FLAKE8) .
+lint: ## check style with ruff
+	$(RUFF) check .
+	$(RUFF) format --check .
+
+format: ## auto-format code with ruff
+	$(RUFF) format .
 
 coverage: ## run tests with coverage report and open HTML in browser
 	$(COVERAGE) run --source=pywikitools/,pywikitools/correctbot/ --omit=pywikitools/user-config.py -m unittest discover -s pywikitools/test

README.md

@@ -97,15 +97,17 @@ From your base pywikitools path (with the virtual environment set up):
 
 ```shell
 $ make test      # run the test suite
-$ make lint      # check style with flake8
+$ make lint      # check style with ruff
+$ make format    # auto-format code with ruff
 $ make coverage  # coverage report; opens htmlcov/ in your browser
 ```
 
 The same commands without `make`:
 
 ```shell
 $ python -m unittest discover -s pywikitools/test
-$ flake8 .
+$ ruff check .
+$ ruff format --check .
 ```
 
 With `GitHub Actions` tests and linting run automatically on every push or pull

pyproject.toml

@@ -0,0 +1,10 @@
+[tool.ruff]
+line-length = 88
+exclude = [
+    "env",
+    "pywikitools/user-config.py",
+    "pywikitools/correctbot/user-config.py",
+]
+
+[tool.ruff.format]
+# defaults (Black-compatible) are sufficient

requirements.txt

@@ -1,4 +1,4 @@
-flake8>=7.3.0
+ruff>=0.8.0
 coverage>=7.3.2
 wikitextparser>=0.54.0
 pywikibot>=8.4.0