Using new guidata.utils.genreqs features (guidata 3.11)

Author: PierreRaybaut

.vscode/tasks.json

@@ -288,16 +288,18 @@
             "type": "shell",
         },
         {
-            "label": "Update requirements.txt",
-            "command": "toml-to-req",
+            "label": "Generate requirements",
+            "command": "${command:python.interpreterPath}",
             "args": [
-                "--toml-file",
-                "pyproject.toml",
-                "--optional-lists",
-                "qt,opencv,dev,doc,test",
+                "-m",
+                "guidata.utils.genreqs",
+                "all",
             ],
             "options": {
                 "cwd": "${workspaceFolder}",
+                "env": {
+                    "PYTHONPATH": "C:/Dev/Projets/guidata",
+                },
                 "statusbar": {
                     "hide": true
                 }
@@ -373,7 +375,11 @@
                 "panel": "dedicated",
                 "showReuseMessage": true,
                 "clear": true
-            }
+            },
+            "dependsOrder": "sequence",
+            "dependsOn": [
+                "Generate requirements",
+            ]
         },
         {
             "label": "Run pytest on all environments",
@@ -588,7 +594,11 @@
                 "panel": "shared",
                 "showReuseMessage": true,
                 "clear": true
-            }
+            },
+            "dependsOrder": "sequence",
+            "dependsOn": [
+                "Generate requirements",
+            ]
         },
         {
             "label": "HTML doc: quick preview",
@@ -653,7 +663,11 @@
                 "panel": "shared",
                 "showReuseMessage": true,
                 "clear": true
-            }
+            },
+            "dependsOrder": "sequence",
+            "dependsOn": [
+                "Generate requirements",
+            ]
         },
         {
             "label": "GitHub Pages: preview",
@@ -764,6 +778,7 @@
             },
             "dependsOrder": "sequence",
             "dependsOn": [
+                "Generate requirements",
                 "Build PDF documentation"
             ]
         },

MANIFEST.in

@@ -6,4 +6,5 @@ include conftest.py
 include CHANGELOG.md
 include CONTRIBUTING.md
 include requirements.txt
+include requirements-min.txt
 include *.desktop

doc/requirements.rst

@@ -1,4 +1,4 @@
-The :mod:`cdl` package requires the following Python modules:
+The `cdl` package requires the following Python modules:
 
 .. list-table::
     :header-rows: 1
@@ -16,6 +16,9 @@ The :mod:`cdl` package requires the following Python modules:
     * - PlotPy
       -  >= 2.7.4
       - Curve and image plotting tools for Python/Qt applications
+    * - NumPy
+      - >=1.19
+      - Fundamental package for array computing in Python
     * - SciPy
       -  >= 1.5
       - Fundamental algorithms for scientific computing in Python
@@ -34,8 +37,21 @@ The :mod:`cdl` package requires the following Python modules:
     * - packaging
       -  >= 20.0
       - Core utilities for Python packages
+    * - tomli
+      - 
+      - A lil' TOML parser
+
+Optional modules for GUI support (Qt):
+
+.. list-table::
+    :header-rows: 1
+    :align: left
+
+    * - Name
+      - Version
+      - Summary
     * - PyQt5
-      - >=5.11
+      - 
       - Python bindings for the Qt cross platform application toolkit
 
 Optional modules for development:
@@ -48,22 +64,22 @@ Optional modules for development:
       - Version
       - Summary
     * - babel
-      -
+      - 
       - Internationalization utilities
     * - Coverage
-      -
+      - 
       - Code coverage measurement for Python
     * - pyinstaller
       - >=6.0
       - PyInstaller bundles a Python application and all its dependencies into a single package.
     * - pylint
-      -
+      - 
       - python code static checker
     * - ruff
-      -
+      - 
       - An extremely fast Python linter and code formatter, written in Rust.
     * - toml-to-requirements
-      -
+      - 
       - Convert a pyproject.toml file to a requirements.txt file
 
 Optional modules for building the documentation:
@@ -76,28 +92,28 @@ Optional modules for building the documentation:
       - Version
       - Summary
     * - PyQt5
-      -
+      - 
       - Python bindings for the Qt cross platform application toolkit
     * - sphinx
-      -
+      - 
       - Python documentation generator
     * - sphinx_intl
-      -
+      - 
       - Sphinx utility that make it easy to translate and to apply translation.
     * - sphinx-sitemap
-      -
+      - 
       - Sitemap generator for Sphinx
     * - myst_parser
-      -
+      - 
       - An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
     * - sphinx_design
-      -
+      - 
       - A sphinx extension for designing beautiful, view size responsive web components.
     * - sphinx-copybutton
-      -
+      - 
       - Add a copy button to each of your code cells.
     * - pydata-sphinx-theme
-      -
+      - 
       - Bootstrap-based Sphinx theme from the PyData community
 
 Optional modules for running test suite:
@@ -110,8 +126,8 @@ Optional modules for running test suite:
       - Version
       - Summary
     * - pytest
-      -
+      - 
       - pytest: simple powerful testing with Python
     * - pytest-xvfb
-      -
+      - 
       - A pytest plugin to run Xvfb (or Xephyr/Xvnc) for tests.

doc/update_requirements.py

@@ -0,0 +1,27 @@
+Coverage
+NumPy==1.19
+PlotPy==2.7.4
+PyQt5
+PyWavelets==1.1
+SciPy==1.5
+babel
+guidata==3.10
+myst_parser
+opencv-python-headless==4.5
+packaging==20.0
+pandas==1.2
+psutil==5.7
+pydata-sphinx-theme
+pyinstaller==6.0
+pylint
+pytest
+pytest-xvfb
+ruff
+scikit-image==0.18
+sphinx
+sphinx-copybutton
+sphinx-sitemap
+sphinx_design
+sphinx_intl
+toml-to-requirements
+tomli

requirements-min.txt

@@ -1,4 +1,5 @@
 Coverage
+NumPy>=1.19
 PlotPy >= 2.7.4
 PyQt5
 PyWavelets >= 1.1
@@ -22,4 +23,5 @@ sphinx-copybutton
 sphinx-sitemap
 sphinx_design
 sphinx_intl
-toml-to-requirements
+toml-to-requirements
+tomli

requirements.txt

@@ -14,7 +14,6 @@ call %FUNC% SetPythonPath
 call %FUNC% UsePython
 call %FUNC% GetVersion CDL_VERSION
 cd %SCRIPTPATH%\..
-%PYTHON% doc\update_requirements.py
 %PYTHON% doc\update_validation_status.py
 %PYTHON% doc\update_processor_methods.py
 

scripts/build_doc.bat

@@ -29,7 +29,6 @@ call %FUNC% SetPythonPath
 call %FUNC% UsePython
 call %FUNC% GetVersion CDL_VERSION
 cd %SCRIPTPATH%\..
-%PYTHON% doc\update_requirements.py
 %PYTHON% doc\update_validation_status.py
 %PYTHON% doc\update_processor_methods.py
 

scripts/build_ghpages.bat

@@ -11,6 +11,5 @@ call %~dp0utils GetScriptPath SCRIPTPATH
 call %FUNC% SetPythonPath
 call %FUNC% UsePython
 cd %SCRIPTPATH%\..
-%PYTHON% doc\update_requirements.py
 %PYTHON% doc\update_validation_status.py
 %PYTHON% doc\update_processor_methods.py