Generate requirements files from pyproject.toml

This PR is based on numpy/numpydoc#483 and scikit-image/scikit-image#7085,
which make pyproject.toml a primary file without any template, and adds a pre-commit script to write requirements files.
It doesn't really change anything, but I would like to keep everything
consistent.

Author: jarrodmillman

.pre-commit-config.yaml

@@ -24,8 +24,8 @@ repos:
           - --fix
   - repo: local
     hooks:
-      - id: pyproject.toml
-        name: pyproject.toml
+      - id: generate_requirements.py
+        name: generate_requirements.py
         language: system
-        entry: python tools/generate_pyproject.toml.py
-        files: "pyproject.toml|requirements/.*\\.txt|tools/.*pyproject.*"
+        entry: python tools/generate_requirements.py
+        files: "pyproject.toml|requirements/.*\\.txt|tools/generate_requirements.py"

pyproject.toml

@@ -1,13 +1,3 @@
-################################################################################
-# DO NOT EDIT
-# AUTOGENERATED BY
-#
-#     $ python tools/generate_pyproject.toml.py
-#
-# EDIT tools/pyproject.toml.in AND RUN THAT SCRIPT.
-#
-################################################################################
-
 [build-system]
 build-backend = 'setuptools.build_meta'
 requires = ['setuptools>=61.2']

requirements/README.md

@@ -2,6 +2,8 @@
 
 ## Index
 
+These files are generated by `tools/generate_requirements.py` from `pyproject.toml`.
+
 - [`default.txt`](default.txt)
   Default requirements
 - [`extra.txt`](extra.txt)

requirements/default.txt

@@ -1,3 +1,5 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 numpy>=1.22
 scipy>=1.9,!=1.11.0,!=1.11.1
 matplotlib>=3.5

requirements/developer.txt

@@ -1,3 +1,5 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 pre-commit>=3.2
 mypy>=1.1
 rtoml

requirements/doc.txt

@@ -1,3 +1,5 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 sphinx>=7
 pydata-sphinx-theme>=0.14
 sphinx-gallery>=0.14

requirements/extra.txt

@@ -1,3 +1,5 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 lxml>=4.6
 pygraphviz>=1.11
 pydot>=1.4.2

requirements/test.txt

@@ -1,2 +1,4 @@
+# Generated via tools/generate_requirements.py and pre-commit hook.
+# Do not edit this file; modify pyproject.toml instead.
 pytest>=7.2
 pytest-cov>=4.0

tools/generate_pyproject.toml.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+"""Generate requirements/*.txt files from pyproject.toml."""
+
+import sys
+from pathlib import Path
+
+try:  # standard module since Python 3.11
+    import tomllib as toml
+except ImportError:
+    try:  # available for older Python via pip
+        import tomli as toml
+    except ImportError:
+        sys.exit("Please install `tomli` first: `pip install tomli`")
+
+script_pth = Path(__file__)
+repo_dir = script_pth.parent.parent
+script_relpth = script_pth.relative_to(repo_dir)
+header = [
+    f"# Generated via {script_relpth.as_posix()} and pre-commit hook.",
+    "# Do not edit this file; modify pyproject.toml instead.",
+]
+
+
+def generate_requirement_file(name: str, req_list: list[str]) -> None:
+    req_fname = repo_dir / "requirements" / f"{name}.txt"
+    req_fname.write_text("\n".join(header + req_list) + "\n")
+
+
+def main() -> None:
+    pyproject = toml.loads((repo_dir / "pyproject.toml").read_text())
+
+    generate_requirement_file("default", pyproject["project"]["dependencies"])
+
+    for key, opt_list in pyproject["project"]["optional-dependencies"].items():
+        generate_requirement_file(key, opt_list)
+
+
+if __name__ == "__main__":
+    main()