Add a script to generate the requirements files

and check that they are up to date in the CI

Signed-off-by: Gaëtan Lehmann <[email protected]>

Author: glehmann

.github/workflows/requirements-check.yml

@@ -0,0 +1,17 @@
+name: Check requirements file consistency
+
+on: [push]
+
+jobs:
+  requirements-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "0.7.x"
+    - name: Install dependencies
+      run: uv sync --frozen
+    - run: uv run ./requirements/update_requirements.py
+    - run: git diff --exit-code

requirements/base.txt

@@ -1,8 +1,9 @@
+# generated with update_requirements.py, do not edit manually
 cryptography>=3.3.1
-GitPython
+gitpython
+legacycrypt
 packaging>=20.7
-pytest>=8.0.0
 pluggy>=1.1.0
-requests
-legacycrypt
+pytest>=8.0.0
 pytest-dependency
+requests

requirements/dev.txt

@@ -1,10 +1,11 @@
-# All requirements + those only used in development
+# generated with update_requirements.py, do not edit manually
 ansible>=5.0.1
 bs4>=0.0.1
-flake8
-PyYAML>=6.0
 mypy
-typing_extensions
+flake8
+pydocstyle
 pyright
+pyyaml>=6.0
 types-requests
+typing-extensions
 -r base.txt

requirements/update_requirements.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+import argparse
+import tomllib
+from pathlib import Path
+
+parser = argparse.ArgumentParser(description="Convert the dependencies from pyproject.toml in requirements.txt files")
+args = parser.parse_args()
+
+PROJECT_DIR = Path(__file__).parent.parent
+HEADER = "# generated with update_requirements.py, do not edit manually"
+
+with open(f'{PROJECT_DIR}/pyproject.toml', 'rb') as f:
+    pyproject = tomllib.load(f)
+
+
+main_deps = pyproject['project']['dependencies']
+with open(f'{PROJECT_DIR}/requirements/base.txt', 'w') as f:
+    print(HEADER, file=f)
+    for dep in main_deps:
+        print(dep, file=f)
+
+dev_deps = pyproject['dependency-groups']['dev']
+with open(f'{PROJECT_DIR}/requirements/dev.txt', 'w') as f:
+    print(HEADER, file=f)
+    for dep in dev_deps:
+        print(dep, file=f)
+    print('-r base.txt', file=f)