Update formatting and linting and add pre-commit

Author: daneah

.github/workflows/packaging.yml

@@ -3,11 +3,11 @@ name: Packaging
 on:
   push:
     branches: [main]
-    tags: ["v*"]        # run on version tags
+    tags: ["v*"] # run on version tags
   pull_request:
-    branches: [main]    # run on PRs targeting main
+    branches: [main] # run on PRs targeting main
   release:
-    types: [published]  # run on Github release
+    types: [published] # run on Github release
 
 jobs:
   check:
@@ -44,7 +44,7 @@ jobs:
 
   build:
     name: Build source distribution
-    needs: [check, test]  # wait for checks and tests
+    needs: [check, test] # wait for checks and tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
@@ -62,14 +62,14 @@ jobs:
 
   publish-pypi:
     name: Publish on PyPI
-    needs: [build]  # wait for build
-    if: github.event_name == 'release'  # only on release
+    needs: [build] # wait for build
+    if: github.event_name == 'release' # only on release
     runs-on: ubuntu-latest
     environment:
       name: pypi
       url: https://pypi.org/p/django-webmention
     permissions:
-      id-token: write  # required for trusted publishing
+      id-token: write # required for trusted publishing
     steps:
       - uses: actions/download-artifact@v7
         with:
@@ -80,14 +80,14 @@ jobs:
 
   publish-pypi-test:
     name: Publish on Test PyPI
-    needs: [build]  # wait for build
-    if: startsWith(github.ref, 'refs/tags/')  # only on tags
+    needs: [build] # wait for build
+    if: startsWith(github.ref, 'refs/tags/') # only on tags
     runs-on: ubuntu-latest
     environment:
       name: pypi-test
       url: https://test.pypi.org/p/django-webmention
     permissions:
-      id-token: write  # required for trusted publishing
+      id-token: write # required for trusted publishing
     steps:
       - uses: actions/download-artifact@v7
         with:

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+# yaml-language-server: $shema=https://json.schemastore.org/pre-commit-config.json
+
+####################################################
+# Checks about the pre-commit configuration itself #
+####################################################
+
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply # Ensures all defined hooks affect at least one file in the repo
+      - id: check-useless-excludes # Ensures all defined excludes apply to at least one file in the repo
+
+  ###########################
+  # General use / built-ins #
+  ###########################
+
+  # Click through to this repository to see what other goodies are available
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast # Checks Python code for syntax errors
+      - id: trailing-whitespace # Removes trailing whitespace from lines in all file types
+      - id: end-of-file-fixer # Fixes last line of all file types
+      - id: check-merge-conflict # Checks if you're about to commit a file that hasn't had conflicts resolved
+      - id: no-commit-to-branch # Checks if you're committing to a disallowed branch (default is master)
+      - id: check-toml # Checks TOML files for syntax errors
+      - id: check-yaml # Checks YAML files for syntax errors
+
+  ##########
+  # Python #
+  ##########
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.1
+    hooks:
+      - id: ruff-check
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          [
+            types-requests,
+          ]
+
+  ############
+  # Markdown #
+  ############
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier

CHANGELOG.md

@@ -1,81 +1,113 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [4.0.0] - 2026-02-19
+
 ### Removed
+
 - Support for Python 3.9
 
 ## [3.0.0] - 2023-01-03
+
 ### Added
+
 - Support for Django 4.0+
 
 ### Removed
+
 - Support for Django versions less than 2.2
 - Support for Python versions less than 3.7
 
 ## [2.0.2] - 2021-02-14
+
 ### Fixed
+
 - Store source content as a string rather than a bytes object
 
 ## [2.0.1] - 2020-08-25
+
 ### Fixed
+
 - Render HTML links in the Django admin by using `format_html` instead of the now-deprecated `allow_tags` attribute
 
 ## [2.0.0] - 2020-08-20
+
 ### Removed
+
 - Support for Python 3.5
 
 ### Added
+
 - Compatibility in the `include_webmention_information` decorator for versions of Django with new-style middleware
 
 ## [1.1.0] - 2019-07-22
+
 ### Changed
+
 - Use static `setup.cfg` for package metadata and tooling configuration
 - Use black code style
 - Lint with pyflakes
 
 ## [1.0.1] - 2018-04-12
+
 ### Fixed
+
 - Made `setup.py` aware that the README content type is, in fact, markdown
 
 ## [1.0.0] - 2018-04-12
+
 ### Added
+
 - Better documentation about testing
 - Coverage configuration
 
 ### Changed
+
 - Use markdown for PyPI README
 
 ## [0.1.0] - 2018-01-02
+
 ### Added
+
 - Mention use of `path()` over `url()` in README
 - Mention use of new-style `MIDDLEWARE` over old-style `MIDDLEWARE_CLASSES` in README
 - Add system check to detect presence of incorrect middleware configuration
 - Update imports and other syntax for forward compatibility with Django 1.10+ and Django 2.0+
 
 ## [0.0.4] - 2016-07-15
+
 ### Changed
+
 - Reworked the unit tests to be runnable under Travis CI to support continuous integration
 
 ## [0.0.3] - 2016-01-22
+
 ### Changed
+
 - Successful POST requests will now receive a 202 Accepted response rather than a 200 OK response
 
 ### Added
+
 - Django 1.9 in frameworks listed in setup.py
 
 ### Fixed
+
 - Errors in documentation
 
 ## [0.0.2] - 2015-07-11
+
 ### Added
+
 - Webmentions are now available for review in the admin console
 - Webmentions are now updated or invalidated when a new webmention notification request is sent
 - Thorough unit testing
 
 ## [0.0.1] - 2015-07-10
+
 ### Added
+
 - Pre-alpha initial release

README.md

@@ -18,24 +18,24 @@ This package does not currently provide functionality for [sending webmentions](
 
 `$ pip install django-webmention`
 
-* Add `'webmention'` to `INSTALLED_APPS`
-* Run `python manage.py migrate webmention`
-* Add the URL patterns to your top-level `urls.py`
-    * `path('webmention/', include('webmention.urls'))` for Django >= 3.2
+- Add `'webmention'` to `INSTALLED_APPS`
+- Run `python manage.py migrate webmention`
+- Add the URL patterns to your top-level `urls.py`
+  - `path('webmention/', include('webmention.urls'))` for Django >= 3.2
 
 ## Usage
 
-* Include webmention information by either:
-    * Installing the middleware in `settings.py` (affects all views)
-        * Append `webmention.middleware.webmention_middleware` to your `MIDDLEWARE` settings
-    * Decorating a specific view with `webmention.middleware.include_webmention_information`
-* View webmention responses in the Django admin interface and mark them as reviewed as needed
+- Include webmention information by either:
+  - Installing the middleware in `settings.py` (affects all views)
+    - Append `webmention.middleware.webmention_middleware` to your `MIDDLEWARE` settings
+  - Decorating a specific view with `webmention.middleware.include_webmention_information`
+- View webmention responses in the Django admin interface and mark them as reviewed as needed
 
 ## Development
 
 ### Setup
 
-* Install [tox](https://tox.readthedocs.io)
+- Install [tox](https://tox.readthedocs.io)
 
 ### Running Tests
 

conftest.py

@@ -3,9 +3,9 @@
 
 @pytest.fixture
 def test_source():
-    return 'http://example.com'
+    return "http://example.com"
 
 
 @pytest.fixture
 def test_target():
-    return 'http://mysite.com'
+    return "http://mysite.com"

pyproject.toml

@@ -45,9 +45,35 @@ readme = { file = "README.md", content-type = "text/markdown" }
 # Tool configuration #
 ######################
 
-[tool.black]
+[tool.ruff]
 line-length = 120
-target-version = ["py310", "py311", "py312", "py313", "py314"]
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "A",
+    "B",
+    "C4",
+    "DTZ",
+    "E",
+    "F",
+    "I",
+    "ISC",
+    "LOG",
+    "PT",
+    "PTH",
+    "RUF",
+    "S",
+    "SIM",
+    "UP",
+]
+ignore = [
+    "E501",
+    "PT019",
+    "RUF012",
+    "S101",
+    "S105",
+]
 
 [tool.mypy]
 python_version = "3.10"
@@ -188,16 +214,16 @@ deps = [
     "ruff",
 ]
 commands = [
-    ["ruff", "check", { replace = "posargs", default = ["--diff", "src/webmention", "tests"], extend = true }],
+    ["ruff", "check", { replace = "posargs", default = ["src/webmention", "tests"], extend = true }],
 ]
 
 [tool.tox.env.format]
 skip_install = true
 deps = [
-    "black",
+    "ruff",
 ]
 commands = [
-    ["black", { replace = "posargs", default = ["--check", "--diff", "src/webmention", "tests"], extend = true }],
+    ["ruff", "format", { replace = "posargs", default = ["src/webmention", "tests"], extend = true }],
 ]
 
 [tool.tox.env.typecheck]

src/webmention/checks.py

@@ -1,6 +1,6 @@
 import django
 from django.conf import settings
-from django.core.checks import Error, register, Tags
+from django.core.checks import Error, Tags, register
 
 
 @register(Tags.compatibility)

src/webmention/migrations/0001_initial.py

@@ -1,12 +1,8 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import models, migrations
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
-    dependencies = []
+    dependencies: list[tuple[str]] = []
 
     operations = [
         migrations.CreateModel(

src/webmention/resolution.py

@@ -1,11 +1,11 @@
-import requests
-
 from urllib.parse import urlparse
 
+import requests
+
 try:
-    from django.core.urlresolvers import resolve, Resolver404
+    from django.core.urlresolvers import Resolver404, resolve
 except ImportError:
-    from django.urls import resolve, Resolver404
+    from django.urls import Resolver404, resolve
 
 
 def url_resolves(url):
@@ -17,7 +17,8 @@ def url_resolves(url):
 
 
 def fetch_and_validate_source(source, target):
-    response = requests.get(source)
+    # TODO: Create a sensible default timeout for this request, and make it configurable
+    response = requests.get(source)  # noqa: S113 until we have a sensible default timeout
     if response.status_code == 200:
         if target in response.text:
             return response.text

src/webmention/views.py

@@ -1,9 +1,9 @@
+from django.http import HttpResponse, HttpResponseBadRequest, HttpResponseServerError
 from django.views.decorators.csrf import csrf_exempt
 from django.views.decorators.http import require_POST
-from django.http import HttpResponseBadRequest, HttpResponseServerError, HttpResponse
 
 from .models import WebMentionResponse
-from .resolution import url_resolves, fetch_and_validate_source, SourceFetchError, TargetNotFoundError
+from .resolution import SourceFetchError, TargetNotFoundError, fetch_and_validate_source, url_resolves
 
 
 @csrf_exempt