chore: port to pdm

Author: agateau-gg

.dockerignore

@@ -1,9 +1,9 @@
 **
 .*
 
-!Pipfile*
+!pdm.lock
 !ggshield
 !README.md
 !LICENSE
-!setup*
+!pyproject.toml
 !docker

.github/workflows/build_release_assets.yml

@@ -26,11 +26,11 @@ jobs:
 
       - name: Install packaging tools
         run: |
-          pip install build
+          pip install --upgrade pdm
 
       - name: Create packages
         run: |
-          python -m build
+          pdm build
 
       - name: Upload packages
         uses: actions/upload-artifact@v4
@@ -141,14 +141,8 @@ jobs:
         shell: bash
         run: |
           $PYTHON_CMD -m pip install --upgrade pip
-          $PYTHON_CMD -m pip install --upgrade \
-            pipenv==2023.12.1
-
-          pipenv install --dev
-          pipenv run pip install pyinstaller==6.7.0
-        env:
-          # Disable lock otherwise Windows-only dependencies like colorama are not installed
-          PIPENV_SKIP_LOCK: 1
+          $PYTHON_CMD -m pip install --upgrade pdm
+          pdm sync --group tests --group standalone
 
       - name: Prepare macOS secrets
         if: startsWith(matrix.os, 'macos-') && inputs.release_mode
@@ -218,9 +212,9 @@ jobs:
           else
             args="--suffix +${GITHUB_SHA:0:7}"
           fi
-          # Run the script with `bash -c` because `pipenv run` does not
+          # Run the script with `bash -c` because `pdm run` does not
           # automatically do it on Windows
-          pipenv run bash -c "scripts/build-os-packages/build-os-packages $args"
+          pdm run bash -c "scripts/build-os-packages/build-os-packages $args"
 
       - name: Override base Docker image used for functional tests on Windows
         if: matrix.os == 'windows-2022'
@@ -235,7 +229,7 @@ jobs:
         # See note about steps requiring the GITGUARDIAN_API at the top of this file
         if: ${{ !github.event.pull_request.head.repo.fork }}
         run: |
-          pipenv run bash -c "scripts/build-os-packages/build-os-packages functests"
+          pdm run bash -c "scripts/build-os-packages/build-os-packages functests"
         env:
           GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}
           GITGUARDIAN_API_URL: ${{ secrets.GITGUARDIAN_API_URL }}

.github/workflows/ci.yml

@@ -34,8 +34,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pipenv==2023.12.1 pre-commit
-          pipenv install --dev --skip-lock
+          python -m pip install --upgrade pdm pre-commit
+          pdm sync
 
       - uses: actions/cache@v3
         with:
@@ -72,10 +72,6 @@ jobs:
   build:
     name: Build and Test
     runs-on: ${{ matrix.os }}
-    env:
-      # We skip pipenv lockfile by default, because a Pipfile.lock should only
-      # be used for the Python version it was generated for.
-      PIPENV_SKIP_LOCK: 1
     strategy:
       fail-fast: false
       matrix:
@@ -92,22 +88,11 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Use Pipfile.lock on locked version of Python
-        # Keep version in sync with scripts/update-pipfile-lock/Dockerfile
-        if: matrix.python-version == '3.10'
-        run: |
-          echo "PIPENV_SKIP_LOCK=0" >> $GITHUB_ENV
-
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade pipenv==2023.12.1
-          pipenv install --system --dev
-      - name: Install Windows dev dependencies
-        if: matrix.os == 'windows-2022'
-        run: |
-          # Those are win32-only dependencies from pytest
-          python -m pip install atomicwrites colorama
+          python -m pip install --upgrade pdm
+          pdm sync --global --project . --group dev --group tests
 
       - name: Override base Docker image used for functional tests on Windows
         if: matrix.os == 'windows-2022'
@@ -119,19 +104,19 @@ jobs:
 
       - name: Ensure a clean package installation
         run: |
-          pip install build wheel check-wheel-contents
-          python -m build --wheel
+          python -m pip install --upgrade check-wheel-contents
+          pdm build --no-sdist
           # The created wheel (.whl) file will be found and analyzed within the `dist/` folder
           check-wheel-contents dist/
 
       - name: Run unit tests
         run: |
-          coverage run --source ggshield -m pytest --disable-pytest-warnings --disable-socket tests/unit
+          pdm run coverage run --source ggshield -m pytest --disable-pytest-warnings --disable-socket tests/unit
 
       - name: Gather coverage report
         run: |
-          coverage report --fail-under=80
-          coverage xml
+          pdm run coverage report --fail-under=80
+          pdm run coverage xml
 
       - uses: codecov/codecov-action@v4
         with:

.github/workflows/perfbench.yml

@@ -36,8 +36,8 @@ jobs:
         run: |
           python --version
           python -m pip install --upgrade pip
-          python -m pip install pipenv==2023.12.1
-          pipenv install --system --skip-lock
+          python -m pip install --upgrade pdm
+          pdm sync --global --project . --prod
 
       - name: Setup benchmark
         run: |

.gitignore

@@ -130,3 +130,6 @@ test-secret-files.json
 # cache
 .cache_ggshield
 *.msi
+
+# pdm
+.pdm-python

.pre-commit-config.yaml

@@ -56,7 +56,7 @@ repos:
     hooks:
       - id: pyright
         name: pyright
-        entry: 'pipenv run pyright'
+        entry: 'pdm run pyright'
         language: system
         types: [python]
         # do not pass filenames, otherwise Pyright might scan files we don't want it to scan
@@ -66,15 +66,15 @@ repos:
     hooks:
       - id: ggshield-local
         name: GitGuardian Shield
-        entry: pipenv run ggshield secret scan pre-commit
+        entry: pdm run ggshield secret scan pre-commit
         language: system
         stages: [pre-commit]
 
   - repo: local
     hooks:
       - id: ggshield-local
         name: GitGuardian Shield
-        entry: pipenv run ggshield secret scan pre-push
+        entry: pdm run ggshield secret scan pre-push
         language: system
         pass_filenames: false
         stages: [pre-push]
@@ -90,15 +90,15 @@ repos:
     hooks:
       - id: import-linter-config
         name: Import Linter Config Check
-        entry: pipenv run ./scripts/check-import-linter-config.sh
+        entry: pdm run ./scripts/check-import-linter-config.sh
         language: system
         pass_filenames: false
         types: [python]
         stages: [pre-commit]
 
       - id: import-linter
         name: Import Linter
-        entry: pipenv run lint-imports
+        entry: pdm run lint-imports
         language: system
         pass_filenames: false
         types: [python]

Dockerfile

@@ -1,11 +1,9 @@
-# Keep image in sync with scripts/update-pipfile-lock/Dockerfile
 FROM python:3.10-slim as build
 
 LABEL maintainer="GitGuardian SRE Team <[email protected]>"
 
 ENV LC_ALL C.UTF-8
 ENV LANG C.UTF-8
-ENV PIPENV_VENV_IN_PROJECT true
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONFAULTHANDLER 1
 ENV PATH /app/.venv/bin:$PATH
@@ -19,11 +17,9 @@ RUN \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-RUN pip3 install pipenv==2023.12.1
-
 COPY . .
 
-RUN pipenv install --ignore-pipfile --deploy
+RUN pip install .
 
 WORKDIR /data
 VOLUME [ "/data" ]

Makefile

@@ -1,5 +1,5 @@
 SHELL :=/bin/bash
-.PHONY: all test unittest functest coverage black flake8 isort lint update-pipfile-lock
+.PHONY: all test unittest functest coverage black flake8 isort lint lock
 .SILENT:
 
 all:
@@ -16,32 +16,32 @@ all:
 	echo "  isort                Run isort linter"
 	echo ""
 	echo "Other targets:"
-	echo "  update-pipfile-lock  Update the Pipfile.lock"
+	echo "  lock                 Update pdm.lock"
 
 test: unittest functest
 
 unittest:
-	pipenv run pytest --disable-pytest-warnings -vvv tests/unit
+	pdm run pytest --disable-pytest-warnings -vvv tests/unit
 
 functest:
 	scripts/run-functional-tests
 
 coverage:
-	pipenv run coverage run --source ggshield -m pytest --disable-pytest-warnings tests/unit
-	pipenv run coverage report --fail-under=80
-	pipenv run coverage xml
-	pipenv run coverage html
+	pdm run coverage run --source ggshield -m pytest --disable-pytest-warnings tests/unit
+	pdm run coverage report --fail-under=80
+	pdm run coverage xml
+	pdm run coverage html
 
 black:
-	pipenv run black .
+	pdm run black .
 
 flake8:
-	pipenv run flake8
+	pdm run flake8
 
 isort:
-	pipenv run isort **/*.py
+	pdm run isort **/*.py
 
 lint: isort black flake8
 
-update-pipfile-lock:
-	scripts/update-pipfile-lock/update-pipfile-lock
+lock:
+	pdm lock --group :all