chore: better attempt at migrating to modern tooling

Author: foosel

.github/workflows/build.yml

@@ -1,11 +1,10 @@
 name: Build pipeline
 on:
   push:
-    branches:
-      - master
-      - devel
+  pull_request:
   release:
     types: [released]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -14,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: 🏗 Set up Python 3.10
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
       - name: 🏗 Install build dependencies
@@ -35,7 +34,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: 🏗 Set up Python 3.10
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
       - name: 🏗 Set up pre-commit
@@ -45,18 +44,57 @@ jobs:
         run: |
           pre-commit run --all-files --show-diff-on-failure
 
+  test-install:
+    name: 🧪 Installation test
+    strategy:
+      matrix:
+        python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+    runs-on: ubuntu-22.04 # change back to ubuntu-latest once we drop Python 3.7
+    steps:
+      - uses: actions/checkout@v4
+      - name: 🏗 Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: 🚀 Set up test dependencies & run test install
+        run: |
+          pip install octoprint
+          pip install -e .[develop]
+
+  e2e:
+    name: 🧪 E2E tests
+    needs: build
+    runs-on: ubuntu-22.04 # change back to ubuntu-latest once we drop Python 3.7 & upgrade playwright
+    strategy:
+      matrix:
+        octoprint: ["master", "maintenance"]
+    steps:
+      - name: ⬇ Download build result
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: 🎭 Run OctoPrint's E2E Tests
+        uses: OctoPrint/actions/e2e@main
+        with:
+          ref: ${{ matrix.octoprint }}
+          deps: ${{ github.workspace }}/dist/*.whl
+          suffix: "-${{ matrix.octoprint }}"
+
   publish-on-testpypi:
     name: 📦 Publish on TestPyPI
     if: github.event_name == 'release'
     needs:
       - build
       - pre-commit
+      - e2e
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     environment:
       name: testpypi
       url: https://test.pypi.org/p/OctoPrint-FirmwareCheck
-    permissions:
-      id-token: write
     steps:
       - name: ⬇ Download build result
         uses: actions/download-artifact@v4
@@ -73,11 +111,11 @@ jobs:
     if: github.event_name == 'release'
     needs: publish-on-testpypi
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     environment:
       name: pypi
       url: https://pypi.org/p/OctoPrint-FirmwareCheck
-    permissions:
-      id-token: write
     steps:
       - name: ⬇ Download build result
         uses: actions/download-artifact@v4

Taskfile.yml

@@ -0,0 +1,79 @@
+# https://taskfile.dev
+
+version: "3"
+
+env:
+  LOCALES: ["de"] # list your included locales here, e.g. ["de", "fr"]
+  TRANSLATIONS: "octoprint_firmware_check/translations" # translations folder, do not touch
+
+tasks:
+  install:
+    desc: Installs the plugin into the current venv
+    cmds:
+      - "python -m pip install -e .[develop]"
+
+  ### Build related
+
+  build:
+    desc: Builds sdist & wheel
+    cmds:
+      - python -m build --sdist --wheel
+
+  build-sdist:
+    desc: Builds sdist
+    cmds:
+      - python -m build --sdist
+
+  build-wheel:
+    desc: Builds wheel
+    cmds:
+      - python -m build --wheel
+
+  ### Translation related
+
+  babel-new:
+    desc: Create a new translation for a locale
+    cmds:
+      - task: babel-extract
+      - |
+        pybabel init --input-file=translations/messages.pot --output-dir=translations --locale="{{ .CLI_ARGS }}"
+
+  babel-extract:
+    desc: Update pot file from source
+    cmds:
+      - pybabel extract --mapping-file=babel.cfg --output-file=translations/messages.pot --msgid-bugs-address=i18n@octoprint.org --copyright-holder="The OctoPrint Project" .
+
+  babel-update:
+    desc: Update translation files from pot file
+    cmds:
+      - for:
+          var: LOCALES
+        cmd: pybabel update --input-file=translations/messages.pot --output-dir=translations --locale={{ .ITEM }}
+
+  babel-refresh:
+    desc: Update translation files from source
+    cmds:
+      - task: babel-extract
+      - task: babel-update
+
+  babel-compile:
+    desc: Compile translation files
+    cmds:
+      - pybabel compile --directory=translations
+
+  babel-bundle:
+    desc: Bundle translations
+    preconditions:
+      - test -d {{ .TRANSLATIONS }}
+    cmds:
+      - for:
+          var: LOCALES
+        cmd: |
+          locale="{{ .ITEM }}"
+          source="translations/${locale}"
+          target="{{ .TRANSLATIONS }}/${locale}"
+
+          [ ! -d "${target}" ] || rm -r "${target}"
+
+          echo "Copying translations for locale ${locale} from ${source} to ${target}..."
+          cp -r "${source}" "${target}"

pyproject.toml

@@ -1,10 +1,50 @@
 [build-system]
-requires = ["setuptools>=40.8.0", "wheel"]
+requires = [
+    "setuptools>=40.8.0",
+    "wheel",
+]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "OctoPrint-FirmwareCheck"
+version = "2025.05.14"
+description = "Checks for unsafe or broken printer firmwares"
+authors = [
+    { name = "Gina Häußge", email = "gina@octoprint.org" },
+]
+requires-python = ">=3.7,<4"
+dependencies = []
+dynamic = [
+    "license",
+]
+
+[project.entry-points."octoprint.plugin"]
+firmware_check = "octoprint_firmware_check"
+
+[project.urls]
+Homepage = "https://github.com/OctoPrint/OctoPrint-FirmwareCheck"
+
+[project.optional-dependencies]
+develop = [
+    "pre-commit",
+    "go-task-bin",
+]
+
+[project.readme]
+file = "README.md"
+content-type = "markdown"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = [
+    "octoprint_firmware_check",
+    "octoprint_firmware_check.*",
+]
+
 [tool.ruff]
 exclude = [
-    # standard stuff
     ".bzr",
     ".direnv",
     ".eggs",
@@ -32,15 +72,20 @@ exclude = [
     "site-packages",
     "venv",
 ]
-
 line-length = 90
 indent-width = 4
-
-# Assume Python 3.7
 target-version = "py37"
 
 [tool.ruff.lint]
-select = ["B", "C", "E", "F", "I", "W", "B9"]
+select = [
+    "B",
+    "C",
+    "E",
+    "F",
+    "I",
+    "W",
+    "B9",
+]
 ignore = [
     "E203",
     "E231",
@@ -53,9 +98,11 @@ ignore = [
     "W605",
     "C901",
 ]
-fixable = ["I", "C4", "E"]
-
-# Allow unused variables when underscore-prefixed.
+fixable = [
+    "I",
+    "C4",
+    "E",
+]
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 [tool.ruff.lint.isort]
@@ -68,17 +115,5 @@ quote-style = "double"
 indent-style = "space"
 skip-magic-trailing-comma = false
 line-ending = "lf"
-
-# Enable auto-formatting of code examples in docstrings. Markdown,
-# reStructuredText code/literal blocks and doctests are all supported.
-#
-# This is currently disabled by default, but it is planned for this
-# to be opt-out in the future.
 docstring-code-format = false
-
-# Set the line length limit used when formatting code snippets in
-# docstrings.
-#
-# This only has an effect when the `docstring-code-format` setting is
-# enabled.
 docstring-code-line-length = "dynamic"