Generate requirements files from pyproject.toml (#483)

Author: mwtoews

.pre-commit-config.yaml

@@ -44,5 +44,5 @@ repos:
       - id: pyproject.toml
         name: pyproject.toml
         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.*"

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']
@@ -67,6 +57,7 @@ test = [
 
 [project.scripts]
 validate-docstrings = 'numpydoc.hooks.validate_docstrings:main'
+
 [tool.setuptools]
 include-package-data = false
 packages = [
@@ -84,6 +75,7 @@ numpydoc = [
     'tests/tinybuild/*.py',
     'templates/*.rst',
 ]
+
 [tool.pytest.ini_options]
 addopts = '''
 --showlocals --doctest-modules -ra --cov-report= --cov=numpydoc

requirements/developer.txt

@@ -1,2 +1,2 @@
 pre-commit>=3.3
-rtoml
+tomli; python_version < '3.11'

requirements/doc.txt

@@ -1,3 +1,4 @@
+# Generated from pyproject.toml
 numpy>=1.22
 matplotlib>=3.5
 pydata-sphinx-theme>=0.13

requirements/test.txt

@@ -1,3 +1,4 @@
+# Generated from pyproject.toml
 pytest
 pytest-cov
 matplotlib

tools/generate_pyproject.toml.py

@@ -0,0 +1,22 @@
+#!/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`")
+
+repo_dir = (Path(__file__).parent / "..").resolve()
+req_dir = repo_dir / "requirements"
+pyproject = toml.loads((repo_dir / "pyproject.toml").read_text())
+
+for key, opt_list in pyproject["project"]["optional-dependencies"].items():
+    lines = ["# Generated from pyproject.toml"] + opt_list
+    req_fname = req_dir / f"{key}.txt"
+    req_fname.write_text("\n".join(lines) + "\n")