chore(pdm): migrate from pipenv to pdm

Author: fnareoh

.github/workflows/test-lint.yml

@@ -26,16 +26,16 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade pipenv==2023.10.3 pre-commit
-          pipenv install --dev --skip-lock
+          python -m pip install --upgrade pdm pre-commit
+          pdm install -G dev --frozen-lockfile
 
       - uses: actions/cache@v3
         with:
@@ -86,14 +86,14 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade pipenv==2023.10.3
-          pipenv install --system --dev --skip-lock
+          python -m pip install --upgrade pdm
+          pdm install --global --project . -G dev --frozen-lockfile
 
       - name: Test with pytest
         run: |
-          pipenv run coverage run --source pygitguardian -m pytest
-          pipenv run coverage report --fail-under=80
-          pipenv run coverage xml
+          pdm run coverage run --source pygitguardian -m pytest
+          pdm run coverage report --fail-under=80
+          pdm run coverage xml
         env:
           GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}
 

.gitignore

@@ -126,3 +126,7 @@ secrets
 
 dist/
 .cache_ggshield
+
+#pdm
+.pdm-python
+pdm.lock

.pre-commit-config.yaml

@@ -18,7 +18,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
@@ -35,7 +35,6 @@ repos:
     rev: v5.10.1
     hooks:
       - id: isort
-        args: [--settings-path, setup.cfg]
 
   - repo: https://github.com/Woile/commitizen
     rev: v2.27.1

CONTRIBUTING.md

@@ -17,8 +17,8 @@ When submitting a bug report be sure that:
 ## Dev environment
 
 ```bash
-pipenv install --dev
-pipenv run pre-commit install -f --hook-type commit-msg --hook-type pre-commit
+pdm install -G dev
+pdm run pre-commit install -f --hook-type commit-msg --hook-type pre-commit
 ```
 
 ## Testing
@@ -48,6 +48,6 @@ Line length in the one enforced by Black: 88 characters.
 
 ### Changelog
 
-We use [scriv](https://github.com/nedbat/scriv) to manage our changelog. It is automatically installed by `pipenv install --dev`.
+We use [scriv](https://github.com/nedbat/scriv) to manage our changelog. It is automatically installed by `pdm install -G dev`.
 
 All user visible changes must be documented in a changelog fragment. You can create one with `scriv create`. If your pull request only contains non-visible changes (such as refactors or fixes for regressions introduced _after_ the latest release), then apply the `skip-changelog` label to the pull request.

Makefile

@@ -11,10 +11,10 @@ all:
 	echo "  lint            Run all linters"
 
 test:
-	pipenv run pytest --disable-pytest-warnings -vvv $(test)
+	pdm run pytest --disable-pytest-warnings -vvv $(test)
 
 coverage:
-	pipenv run coverage run --source pygitguardian -m pytest --disable-pytest-warnings && pipenv run coverage report --fail-under=80
+	pdm run coverage run --source pygitguardian -m pytest --disable-pytest-warnings && pdm run coverage report --fail-under=80
 
 lint:
 	pre-commit run --all

Pipfile

@@ -41,6 +41,12 @@ pip3 install --upgrade pygitguardian
 pipenv install pygitguardian
 ```
 
+**pdm**
+
+```bash
+pdm add pygitguardian
+```
+
 **poetry**
 
 ```bash

README.md

@@ -1,3 +1,65 @@
+[project]
+name = "pygitguardian"
+version = "1.14.0"
+description = "Python Wrapper for GitGuardian's API -- Scan security policy breaks everywhere"
+keywords = [
+    "api-client devsecops secrets-detection security-tools library gitguardian",
+]
+readme = "README.md"
+authors = [
+    {name = "GitGuardian", email = "[email protected]"},
+]
+maintainers = [
+    {name = "GitGuardian", email = "[email protected]"},
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Topic :: Security",
+]
+license = {text = "MIT"}
+requires-python = ">=3.8"
+dependencies = [
+    "marshmallow>=3.5, <4",
+    "requests>=2, <3",
+    "marshmallow-dataclass >=8.5.8, <8.6.0",
+    "typing-extensions",
+    "setuptools>=70.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/GitGuardian/py-gitguardian"
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "black==24.3.0",
+    "coverage",
+    "flake8",
+    "flake8-isort",
+    "isort",
+    "pre-commit",
+    "pytest",
+    "vcrpy!=4.3.1,<4.4.0,>=4.3.0",
+    "urllib3<2",
+    "scriv[toml]",
+    "responses<0.24.0,>=0.23.1",
+    "pyright==1.1.367",
+]
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
 [tool.black]
 target-version = ['py39']
 line-length = 88

pyproject.toml

@@ -2,10 +2,7 @@
 ignore = E203,W503
 inline-quotes = double
 max-line-length = 120
-
-[isort]
-profile = black
-lines_after_imports = 2
-
-[metadata]
-description-file = README.md
+exclude =
+    __pycache__
+    .venv
+    .git