use ruff rules for isort, add codespell (#70)

Author: jameslamb

.github/workflows/main.yml

@@ -1,6 +1,6 @@
 name: Continuous Integration
 
-# alwas run CI on new commits to any branch
+# always run CI on new commits to any branch
 on: push
 
 jobs:
@@ -20,7 +20,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
         with:
-          # 'driver: docker' allows one build to re-use images from a prior build
+          # 'driver: docker' allows one build to reuse images from a prior build
           # ref: https://github.com/docker/setup-buildx-action/issues/251
           driver: docker
           install: true

.pre-commit-config.yaml

@@ -11,14 +11,8 @@ repos:
       - id: check-toml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--settings-path", "pyproject.toml"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.14.0
+    rev: v1.14.1
     hooks:
       - id: mypy
         args: ["--config-file", "pyproject.toml"]
@@ -31,7 +25,7 @@ repos:
     hooks:
       # Run the linter.
       - id: ruff
-        args: ["--config", "pyproject.toml"]
+        args: ["--config", "pyproject.toml", "--fix"]
         types_or: [jupyter, python]
       # Run the formatter.
       - id: ruff-format
@@ -51,3 +45,9 @@ repos:
     rev: v1.35.1
     hooks:
       - id: yamllint
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        additional_dependencies: [tomli]
+        args: ["--toml", "pyproject.toml"]

README.md

@@ -1,6 +1,6 @@
 # Testing `lightgbm.dask`
 
-[![GitHub Actions status](https://github.com/jameslamb/lightgbm-dask-testing/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/jameslamb/lightgbm-dask-testing/actions)
+[![GitHub Actions](https://github.com/jameslamb/lightgbm-dask-testing/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/jameslamb/lightgbm-dask-testing/actions/workflows/main.yml)
 
 This repository can be used to test and develop changes to LightGBM's Dask integration.
 It contains the following useful features:
@@ -110,7 +110,7 @@ pip install --upgrade awscli
 Next, configure your shell to make authenticated requests to AWS.
 If you've never done this, you can see [the AWS CLI docs](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
 
-The rest of this section assums that the shell variables `AWS_SECRET_ACCESS_KEY` and `AWS_ACCESS_KEY_ID` have been sett.
+The rest of this section assumes that the shell variables `AWS_SECRET_ACCESS_KEY` and `AWS_ACCESS_KEY_ID` have been sett.
 
 I like to set these by keeping them in a file
 

pyproject.toml

@@ -8,6 +8,8 @@ select = [
     "E",
     # pyflakes
     "F",
+    # isort
+    "I",
     # NumPy-specific rules
     "NPY",
     # pylint
@@ -18,6 +20,19 @@ select = [
     "SIM401",
 ]
 
+[tool.ruff.lint.isort]
+
+# prevent ruff from thinking that 'lightgbm.dask' imports should
+# come after all others
+known-third-party = [
+  "dask",
+  "dask_cloudprovider",
+  "lightgbm",
+  "pandas",
+  "scipy",
+  "sklearn",
+]
+
 [tool.ruff.lint.per-file-ignores]
 "*.ipynb" = [
   # (pylint) Unnecessary list() call