Packaging: switch to pyproject.toml (#556)

Author: Guts

.github/labeler.yml

@@ -1,68 +1,68 @@
 bug:
-  - head-branch:
-      - ^fix
-      - fix
-      - ^hotfix
-      - hotfix
+    - head-branch:
+          - ^fix
+          - fix
+          - ^hotfix
+          - hotfix
 
 ci-cd:
-  - changed-files:
-      - any-glob-to-any-file:
-          - .github/**
+    - changed-files:
+          - any-glob-to-any-file:
+                - .github/**
 
 dependencies:
-  - changed-files:
-      - any-glob-to-any-file:
-          - requirements/*.txt
-          - requirements.txt
+    - changed-files:
+          - any-glob-to-any-file:
+                - pyproject.toml
 
 documentation:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "*.md"
-          - docs/**
-          - examples/**
-          - requirements/documentation.txt
-  - head-branch:
-      - ^docs
-      - documentation
+    - changed-files:
+          - any-glob-to-any-file:
+                - "*.md"
+                - docs/**
+                - examples/**
+                - scripts/*.ps1
+    - head-branch:
+          - ^docs
+          - documentation
 
 enhancement:
-  - head-branch:
-      - ^feature
-      - feature
-      - ^improve
-      - improve
+    - head-branch:
+          - ^feature
+          - feature
+          - ^improve
+          - improve
 
 jobs:
-  - changed-files:
-      - any-glob-to-any-file:
-          - qgis_deployment_toolbelt/jobs/**/*
+    - changed-files:
+          - any-glob-to-any-file:
+                - qgis_deployment_toolbelt/jobs/**/*
 
 packaging:
-  - changed-files:
-      - any-glob-to-any-file:
-          - builder/**/*
-          - Dockerfile
-          - setup.py
-          - .dockerignore
-  - head-branch:
-      - ^packaging
-      - packaging
+    - changed-files:
+          - any-glob-to-any-file:
+                - .dockerignore
+                - builder/**/*
+                - Dockerfile
+                - pyproject.toml
+                - .dockerignore
+    - head-branch:
+          - ^packaging
+          - packaging
 
 quality:
-  - changed-files:
-      - any-glob-to-any-file:
-          - tests/**/*
+    - changed-files:
+          - any-glob-to-any-file:
+                - tests/**/*
 
 tooling:
-  - changed-files:
-      - any-glob-to-any-file:
-          - ".*"
-          - codecov.yml
-          - setup.cfg
-          - sonar-project.properties
-          - .vscode/**/*
-  - head-branch:
-      - ^tooling
-      - tooling
+    - changed-files:
+          - any-glob-to-any-file:
+                - ".*"
+                - codecov.yml
+                - pyproject.toml
+                - sonar-project.properties
+                - .vscode/**/*
+    - head-branch:
+          - ^tooling
+          - tooling

.github/workflows/build_release.yml

@@ -10,6 +10,7 @@ on:
       - ".github/workflows/build_release.yml"
       - "builder/**/*"
       - "qgis_deployment_toolbelt/**/*.py"
+      - pyproject.toml
 
     tags:
       - "*"
@@ -20,7 +21,7 @@ on:
     paths:
       - ".github/workflows/build_release.yml"
       - "builder/"
-      - "requirements/packaging.txt"
+      - pyproject.toml
 
 # Globals
 env:
@@ -47,13 +48,12 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/*.txt"
+          cache-dependency-path: pyproject.toml
 
-      - name: Install project requirements
+      - name: Install Python requirements
         run: |
           python -m pip install -U pip setuptools wheel
-          python -m pip install -U -r requirements.txt
-          python -m pip install -U build
+          python -m pip install -U build setuptools-scm
 
       - name: Install project as a package
         run: python -m pip install -e .
@@ -87,16 +87,15 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/*.txt"
+          cache-dependency-path: pyproject.toml
 
-      - name: Install project requirements
+      - name: Install Python requirements
         run: |
           python -m pip install -U pip setuptools wheel
-          python -m pip install -U -r requirements.txt
-          python -m pip install -U -r requirements/packaging.txt
+          
 
       - name: Install project as a package
-        run: python -m pip install -e .
+        run: python -m pip install -e .[packaging]
 
       - name: Generates Executable
         run: python -O ./builder/pyinstaller_build_macos.py
@@ -122,16 +121,14 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/*.txt"
+          cache-dependency-path: pyproject.toml
 
-      - name: Install project requirements
+      - name: Install Python requirements
         run: |
           python -m pip install -U pip setuptools wheel
-          python -m pip install -U -r requirements.txt
-          python -m pip install -U -r requirements/packaging.txt
 
       - name: Install project as a package
-        run: python -m pip install -e .
+        run: python -m pip install -e .[packaging]
 
       - name: Generates Executable
         run: python -O ./builder/pyinstaller_build_ubuntu.py
@@ -157,16 +154,14 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/*.txt"
+          cache-dependency-path: pyproject.toml
 
-      - name: Install project requirements
+      - name: Install Python requirements
         run: |
           python -m pip install -U pip setuptools wheel
-          python -m pip install -U -r requirements.txt
-          python -m pip install -U -r requirements/packaging.txt
 
       - name: Install project as a package
-        run: python -m pip install -e .
+        run: python -m pip install -e .[packaging]
 
       - name: Generates MS Version Info
         run: python .\builder\version_info_templater.py

.github/workflows/documentation.yml

@@ -17,7 +17,7 @@ on:
       - ".github/workflows/documentation.yml"
       - "docs/**/*"
       - "qgis_deployment_toolbelt/**/*.py"
-      - requirements/documentation.txt
+      - pyproject.toml
 
     tags:
       - "*"
@@ -28,7 +28,6 @@ on:
     paths:
       - ".github/workflows/documentation.yml"
       - docs/**/*
-      - requirements/documentation.txt
 
   workflow_dispatch:
 
@@ -51,12 +50,11 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/*.txt"
+          cache-dependency-path: pyproject.toml
 
       - name: Install project requirements
         run: |
           python -m pip install -U pip setuptools wheel
-          python -m pip install -U -r requirements.txt
 
       - name: Install project as a package
         run: python -m pip install -e .
@@ -77,8 +75,7 @@ jobs:
 
       - name: Install documentation requirements
         run: |
-          python -m pip install -U -r requirements/development.txt
-          python -m pip install -U -r requirements/documentation.txt
+          python -m pip install -U .[doc]
 
       - name: Build doc using Sphinx
         env:

.github/workflows/lint.yml

@@ -8,22 +8,20 @@ on:
     paths:
       - ".github/workflows/security.yml"
       - "qgis_deployment_toolbelt"
-      - "requirements/base.txt"
-      - "requirements/security.txt"
+      - pyproject.toml
 
   pull_request:
     branches:
       - main
     paths:
       - ".github/workflows/security.yml"
       - "qgis_deployment_toolbelt"
-      - "requirements/base.txt"
-      - "requirements/security.txt"
+      - pyproject.toml
 
 # Globals
 env:
   PROJECT_FOLDER: "qgis_deployment_toolbelt"
-  PYTHON_VERSION: "3.11"
+  PYTHON_VERSION: "3.13"
 
 # Sets permissions of the GITHUB_TOKEN
 permissions:
@@ -44,13 +42,13 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/security.txt"
+          cache-dependency-path: pyproject.toml
 
-      - name: Install project requirements
+      - name: Install Python requirements
         run: python -m pip install -U pip setuptools wheel
 
       - name: Install security dependencies
-        run: python -m pip install -U -r requirements/security.txt
+        run: python -m pip install -U -e .[security]
 
       - name: Run Bandit check
         run: bandit --configfile bandit.yaml --format screen -r qgis_deployment_toolbelt
@@ -68,13 +66,13 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: "pip"
-          cache-dependency-path: "requirements/security.txt"
+          cache-dependency-path: pyproject.toml
 
       - name: Install project requirements
         run: python -m pip install -U pip setuptools wheel
 
       - name: Install security dependencies
-        run: python -m pip install -U -r requirements/security.txt
+        run: python -m pip install -U -e .[security]
 
       - name: Run Safety scan (pyupio)
         uses: pyupio/safety-action@v1