Use ruff for code linting

.github/workflows/ci-build.yml

@@ -26,5 +26,13 @@ jobs:
         run: |
           pip install .[dev]
 
+      - name: Check formatting
+        run: |
+          make check-format
+
+      - name: Check linting
+        run: |
+          make check-fix
+
       - name: Run tests
         run: pytest

Makefile

@@ -1,10 +1,16 @@
-run:    build
-	@docker run \
-	    --rm \
-		-ti \
-	    scraperwiki-python
+test:
+	@pytest
 
-build:
-	@docker build -t scraperwiki-python .
+fix:
+	@ruff check --fix
 
-.PHONY: run build
+check-fix:
+	@ruff check
+
+format:
+	@ruff format
+
+check-format:
+	@ruff format --check
+
+.PHONY: test fix check-fix format check-format

benchmark.py

@@ -2,14 +2,14 @@
 import scraperwiki
 import os
 
-rows = [{'id': i, 'test': i * 2, 's': "abc"} for i in range(1000)]
+rows = [{"id": i, "test": i * 2, "s": "abc"} for i in range(1000)]
 
 try:
-    os.remove('scraperwiki.sqlite')
+    os.remove("scraperwiki.sqlite")
 except FileNotFoundError:
     pass
 
-scraperwiki.sql.save(['id'], rows)
+scraperwiki.sql.save(["id"], rows)
 
 for i, row in enumerate(rows):
-    scraperwiki.sql.save(['id'], row)
+    scraperwiki.sql.save(["id"], row)

pyproject.toml

@@ -31,10 +31,14 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
+    "ruff",
     "pytest",
     "lxml",
 ]
 
+[tool.ruff]
+line-length = 88
+
 [tool.setuptools.packages.find]
 where = ["."]  # Or wherever your 'scraperwiki' package folder is located
 include = ["scraperwiki*"]

save_speedtest.py

@@ -1,7 +1,7 @@
 #! /usr/bin/env python3
 import scraperwiki
 
-rows = [{'id': i, 'test': i * 2, 's': "xx"*i} for i in range(10)]
+rows = [{"id": i, "test": i * 2, "s": "xx" * i} for i in range(10)]
 
 for i, row in enumerate(rows):
-	scraperwiki.sql.save(['id'], row)
+    scraperwiki.sql.save(["id"], row)

scraperwiki/__init__.py

@@ -1,19 +1,33 @@
-'''
+"""
 Local version of ScraperWiki Utils, documentation here:
 https://scraperwiki.com/docs/python/python_help_documentation/
-'''
+"""
+
 from .utils import scrape, pdftoxml, status, swimport
 from . import utils
 from . import sql
 
 # Compatibility
 sqlite = sql
 
+__all__ = [
+    "scrape",
+    "pdftoxml",
+    "status",
+    "swimport",
+    "utils",
+    "sql",
+]
+
+
 class Error(Exception):
     """All ScraperWiki exceptions are instances of this class
     (usually via a subclass)."""
+
     pass
 
+
 class CPUTimeExceededError(Error):
     """CPU time limit exceeded."""
+
     pass