Merge pull request #1611 from wyardley/wyardley/chore/ruff

chore: switch to ruff for code formatting

Author: jamesoff

.github/workflows/linting.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     name: Python ${{ matrix.python-version }}
 
     steps:
@@ -26,10 +26,10 @@ jobs:
         run: pip install poetry
       - name: poetry install
         run: poetry install
-      - name: check code style with black
-        run: make black
-      - name: flake8 tests
-        run: make flake8
+      - name: check code style with ruff
+        run: make ruff-format-check
+      - name: ruff check
+        run: make ruff-check
       - name: bandit
         run: make bandit
       - name: mypy

.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     name: Python ${{ matrix.python-version }}
 
     steps:

.github/workflows/windows.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     name: Python ${{ matrix.python-version }} (Windows)
 
     steps:

.pre-commit-config.yaml

@@ -1,34 +1,36 @@
+---
 repos:
-    - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v2.3.0
-      hooks:
-          - id: check-yaml
-          - id: end-of-file-fixer
-            exclude: |
-              (?x)^(
-                simplemonitor/html/dist/.*bundle.js
-              )$
-          - id: trailing-whitespace
-            exclude: |
-              (?x)^(
-                tests/test_alerter.py|
-                tests/html/.*
-              )$
-          - id: flake8
-    - repo: https://github.com/psf/black
-      rev: 25.1.0
-      hooks:
-          - id: black
-    - repo: https://github.com/asottile/seed-isort-config
-      rev: v2.2.0
-      hooks:
-          - id: seed-isort-config
-    - repo: https://github.com/pre-commit/mirrors-isort
-      rev: v5.9.2 # pick the isort version you'd like to use from https://github.com/pre-commit/mirrors-isort/releases
-      hooks:
-          - id: isort
-    - repo: https://github.com/pre-commit/mirrors-mypy
-      rev: v0.910
-      hooks:
-          - id: mypy
-            args: ["--install-types", "--non-interactive"]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+        exclude: |
+          (?x)^(
+            simplemonitor/html/dist/.*bundle.js
+          )$
+      - id: trailing-whitespace
+        exclude: |
+          (?x)^(
+            tests/test_alerter.py|
+            tests/html/.*
+          )$
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+      - id: seed-isort-config
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.910
+    hooks:
+      - id: mypy
+        args: ["--install-types", "--non-interactive"]

Makefile

@@ -1,4 +1,4 @@
-.PHONY: flake8 dist twine twine-test integration-tests env-test network-test black mypy linting mypy-strict bandit bandit-strict
+.PHONY: dist twine twine-test integration-tests env-test network-test ruff-check ruff-format ruff-format-check mypy linting mypy-strict bandit bandit-strict
 
 ifeq ($(OS),Windows_NT)
 MOCKSPATH := tests\mocks;
@@ -9,9 +9,6 @@ INTEGRATION_CONFIG := tests/monitor.ini
 endif
 PIPENV := $(shell which poetry)
 
-flake8:
-	poetry run ruff check monitor.py simplemonitor/
-
 integration-tests:
 	PATH="$(MOCKSPATH)$(PATH)" $(PIPENV) run coverage run monitor.py -1 -v -d -f $(INTEGRATION_CONFIG) -j 1
 
@@ -39,8 +36,14 @@ twine-test:
 twine:
 	poetry run python -m twine upload dist/*
 
-black:
-	poetry run black --check --diff *.py simplemonitor/
+ruff-check:
+	poetry run ruff check monitor.py simplemonitor/
+
+ruff-format:
+	poetry run ruff format
+
+ruff-format-check:
+	poetry run ruff format --check --diff
 
 mypy:
 	poetry run mypy *.py simplemonitor/
@@ -54,7 +57,7 @@ bandit:
 bandit-strict:
 	poetry run bandit -r -l *.py simplemonitor/
 
-linting: black flake8 mypy bandit
+linting: ruff-format ruff-check mypy bandit
 
 docker-build:
 	docker build -f docker/monitor.Dockerfile .

README.md

@@ -2,7 +2,7 @@
 
 ![Tests (Windows)](https://github.com/jamesoff/simplemonitor/workflows/Tests%20(Windows)/badge.svg) ![Tests (Linux)](https://github.com/jamesoff/simplemonitor/workflows/Tests%20(Linux)/badge.svg) ![Linting](https://github.com/jamesoff/simplemonitor/workflows/Linting/badge.svg)
 
-[![codecov](https://codecov.io/gh/jamesoff/simplemonitor/branch/master/graph/badge.svg)](https://codecov.io/gh/jamesoff/simplemonitor) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![codecov](https://codecov.io/gh/jamesoff/simplemonitor/branch/master/graph/badge.svg)](https://codecov.io/gh/jamesoff/simplemonitor) [![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v0.json)](https://github.com/astral-sh/ruff)
 
 SimpleMonitor is a Python script which monitors hosts and network connectivity. It is designed to be quick and easy to set up and lacks complex features that can make things like Nagios, OpenNMS and Zenoss overkill for a small business or home network. Remote monitor instances can send their results back to a central location.