Replace setuptools by scikit-build-core to build wheels. (#1400)

Author: bcoconni

.github/workflows/cpp-python-build.yml

@@ -375,7 +375,6 @@ jobs:
             build/src/RelWithDebInfo/JSBSim.lib
             build/src/RelWithDebInfo/JSBSim.exe
             build/utils/aeromatic++/RelWithDebInfo/aeromatic.exe
-            build/python/setup.py
             MSVC_version.txt
 
   Windows-installer:
@@ -497,18 +496,10 @@ jobs:
         working-directory: build
         run: ctest --parallel $(sysctl -n hw.logicalcpu) --output-on-failure
       - name: Build the source package for Python
-        if: env.release == 'true'
-        working-directory: build/python
         run: |
-          echo "::group::Generate the type hints stub"
-          python ../../python/pyxstubgen.py --pyxfile=_jsbsim.pyx --output=jsbsim/_jsbsim.pyi
-          touch jsbsim/py.typed
-          echo "::endgroup::"
-
-          echo "::group::Build the source package"
-          rm -f _jsbsim.cxx  # Make sure that jsbsim.cxx is not stored in the source distribution
+          python python/pyxstubgen.py --pyxfile=build/python/_jsbsim.pyx --output=python/_jsbsim.pyi
+          cp build/python/pyproject.toml .
           python -m build --sdist
-          echo "::endgroup::"
       - name: Check reset for real time execution
         run: |
           start_time=$(date +%s)
@@ -532,16 +523,12 @@ jobs:
 
       - name: Upload Files for Release
         uses: actions/upload-artifact@v7
-        if: env.release == 'true'
         with:
           name: ${{ runner.os }}.binaries
           path: |
-            build/src/libJSBSim.a
-            build/python/setup.py
-            build/python/dist/*.tar.gz
+            dist/*.tar.gz
 
   Test-Build-PyPackage-From-Source:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/'))
     name: Build Python Module from Source
     needs: MacOSX
     strategy:
@@ -560,14 +547,9 @@ jobs:
         uses: actions/download-artifact@v8
         with:
           name: macOS.binaries
-      - name: Build Python module from sources (Linux & MacOSX)
-        if: runner.os != 'Windows'
-        run: pip install python/dist/*.tar.gz -vv
-      - name: Build Python module from sources (Windows)
-        if: runner.os == 'Windows'
-        run: |
-          $PyPackage = Get-ChildItem -Path python\dist -Filter *.tar.gz | Select-Object -First 1
-          pip install $PyPackage.FullName -vv
+      - name: Build Python module from sources
+        shell: bash
+        run: pip install *.tar.gz -vv
       - name: Test Python module
         shell: python
         run: |
@@ -582,6 +564,8 @@ jobs:
         run: |
           echo "import jsbsim" > test.py
           mypy test.py
+      - name: Test JSBSim.py script
+        run: jsbsim --help
 
   Python-Wheels:
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
@@ -596,83 +580,32 @@ jobs:
     steps:
       - name: Checkout JSBSim
         uses: actions/checkout@v6
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v6
-        with:
-          python-version: '3.10'
-      - name: Install Python packages
-        run: pip install -U cython 'numpy>=1.20' mypy
-      - name: Install Doxygen (Linux)
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          sudo apt-get update
-          sudo apt-get install doxygen
-      - name: Install Doxygen (MacOSX)
-        if: matrix.os == 'macos-14'
-        run: brew install doxygen
-      - name: Install Doxygen (Windows)
-        if: runner.os == 'Windows'
-        run: choco install doxygen.install
-      - name: Configure Doxygen
-        run: |
-          # We don't want Doxygen to generate the HTML docs in this job (saves time)
-          # Set GENERATE_HTML and HAVE_DOT to NO
-          perl -i -pe 's/^(GENERATE_HTML\s*=\s*)YES/\1NO/g' doc/JSBSim.dox.in
-          perl -i -pe 's/^(HAVE_DOT\s*=\s*)YES/\1NO/g' doc/JSBSim.dox.in
       - name: Download source package
         uses: actions/download-artifact@v8
         with:
           name: macOS.binaries
-      - name: Configure JSBSim (BSD/Unix)
-        if: runner.os != 'Windows'
+      - name: Identify the source distribution
+        shell: bash
         run: |
-          echo "::group::Run CMake"
-          mkdir build && cd build
-          cmake ..
-          echo "::endgroup::"
-
-          echo "::group::Get Python package sources"
-          touch python/jsbsim/py.typed
-          cd ../python/dist
-          tar zxvf *.tar.gz
-          cp -R jsbsim-*/jsbsim/*.pyi ../../build/python/jsbsim/.
-          echo "::endgroup::"
-      - name: Configure JSBSim (Windows)
-        if: runner.os == 'Windows'
-        run: |
-          echo "::group::Run CMake"
-          New-Item -Path .\build -ItemType Directory -Force
-          cd build
-          cmake ..
-          cmake --build . --target libJSBSim --config RelWithDebInfo --parallel $Env:NUMBER_OF_PROCESSORS
-          echo "::endgroup::"
-
-          echo "::group::Get Python package sources"
-          New-Item python\jsbsim\py.typed
-          cd ..\python\dist
-          $PyPackage = Get-ChildItem .\*.tar.gz -Name
-          tar zxvf $PyPackage
-          Copy-Item -Path .\JSBSim-*\jsbsim\*.pyi -Destination ..\..\build\python\jsbsim
-          echo "::endgroup::"
+          SDIST_PATH=$(ls jsbsim-*.tar.gz | head -n 1)
+          echo "SDIST_PATH=$SDIST_PATH" >> $GITHUB_ENV
       - name: Build wheels
         uses: pypa/cibuildwheel@v3.3
         env:
-          CIBW_BEFORE_ALL_LINUX: |
-            cd build
-            rm -f CMakeCache.txt
-            cmake -DCMAKE_C_FLAGS_RELEASE="-g -O2 -DNDEBUG -fno-math-errno" -DCMAKE_CXX_FLAGS_RELEASE="-g -O2 -DNDEBUG -fno-math-errno" -DCMAKE_BUILD_TYPE=Release ..
-            cmake --build . --target libJSBSim --parallel $(nproc)
-          CIBW_BEFORE_ALL_MACOS: |
-            cd build
-            rm -f CMakeCache.txt
-            cmake -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" -DCMAKE_C_FLAGS_RELEASE="-g -O2 -DNDEBUG -fno-math-errno -fno-fast-math" -DCMAKE_CXX_FLAGS_RELEASE="-g -O2 -DNDEBUG -fno-math-errno -fno-fast-math" -DCMAKE_BUILD_TYPE=Release ..
-            cmake --build . --target libJSBSim --parallel $(sysctl -n hw.logicalcpu)
           CIBW_ARCHS_MACOS: universal2
           CIBW_SKIP: cp*-musllinux_*
           CIBW_ARCHS_WINDOWS: native
-          JSBSIM_BUILD_CONFIG: RelWithDebInfo
+          # Force the buid directory to allow reusing compiled files.
+          CIBW_CONFIG_SETTINGS_LINUX: "build-dir=${{ runner.temp }}/jsbsim_build_cache"
+          SKBUILD_BUILD_DIR: "${{ runner.temp }}/jsbsim_build_cache"
+        with:
+          package-dir: ${{ env.SDIST_PATH }}
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v6
         with:
-          package-dir: build/python
+          python-version: '3.10'
+      - name: Install Python packages
+        run: pip install -U 'numpy>=1.20' mypy
       - name: Test wheel package
         run: |
           echo "::group::Test module execution"
@@ -733,7 +666,6 @@ jobs:
         run: |
           mkdir dist
           find . -type f -name *.exe -exec cp {} dist/. \;
-          find . -type f -name *.whl -exec cp {} dist/. \;
           find . -type f -name *.deb -exec cp {} dist/. \;
       - name: Rolling release
         uses: softprops/action-gh-release@v2
@@ -748,7 +680,6 @@ jobs:
             (branch ${{ github.ref }} commit ${{ github.sha}})
           files: |
             dist/*.exe
-            dist/*.whl
             dist/*.deb
 
   Stable-Release:

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.15)
+cmake_minimum_required (VERSION 3.18)
 
 ################################################################################
 # Project description                                                          #
@@ -28,14 +28,20 @@ function(get_tail INPUT_STRING OUTPUT_STRING SEPARATOR)
   set(${OUTPUT_STRING} ${TAIL} PARENT_SCOPE)
 endfunction()
 
-find_package(PkgConfig)
+if(NOT SKBUILD)
+  find_package(PkgConfig)
+  find_package(CxxTest)
+endif(NOT SKBUILD)
 
 ################################################################################
 # Build JSBSim libs and exec                                                   #
 ################################################################################
 
-list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/tests/unit_tests/CMakeModules)
-find_package(codecov)
+if(CXXTEST_FOUND)
+  list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/tests/unit_tests/CMakeModules)
+  find_package(codecov)
+endif(CXXTEST_FOUND)
+
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 add_subdirectory(src)
 
@@ -72,16 +78,18 @@ option(INSTALL_JSBSIM_PYTHON_MODULE "Set to ON to install the Python module for
 if (BUILD_PYTHON_MODULE)
   list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/python/CMakeModules)
   cmake_policy(SET CMP0094 NEW)  # makes FindPython3 prefer activated virtualenv Python to the latest version
-  find_package(Python3 COMPONENTS Interpreter Development)
+  find_package(Python3 COMPONENTS Interpreter Development.Module)
   find_package(Cython)
 
   if (CYTHON_FOUND)
-    if (Python3_Development_FOUND)
-      enable_testing()
-      add_subdirectory(tests)
+    if (Python3_Development.Module_FOUND)
+      if (NOT SKBUILD)
+        enable_testing()
+        add_subdirectory(tests)
+      endif(NOT SKBUILD)
       add_subdirectory(python)
-    endif(Python3_Development_FOUND)
-  elseif(NOT Python3_Development_FOUND)
+    endif(Python3_Development.Module_FOUND)
+  elseif(NOT Python3_Development.Module_FOUND)
     message(WARNING "JSBSim Python module and test suite will not be built")
   endif(CYTHON_FOUND)
 endif(BUILD_PYTHON_MODULE)
@@ -111,8 +119,6 @@ endif(BUILD_MATLAB_SFUNCTION)
 # Build the unit tests (needs CxxTest)                                         #
 ################################################################################
 
-find_package(CxxTest)
-
 if (CXXTEST_FOUND)
   enable_testing()
   add_subdirectory(tests/unit_tests)
@@ -243,7 +249,7 @@ endif()
 # Windows installer                                                            #
 ################################################################################
 
-if(WIN32)
+if(WIN32 AND NOT SKBUILD)
   configure_file(${PROJECT_SOURCE_DIR}/JSBSim.iss.in JSBSim.iss)
 endif()
 
@@ -277,12 +283,17 @@ set(CPACK_SOURCE_IGNORE_FILES "${CMAKE_BINARY_DIR}/"
                                "/CVS/"
                                "TAGS"
                                "${CPACK_SOURCE_IGNORE_FILES}")
-include (CPack)
+if(NOT SKBUILD)
+  set(CPACK_COMPONENTS_ALL "devel" "pymodules" "runtime")
+  include (CPack)
+endif(NOT SKBUILD)
 
 add_custom_target(dist COMMAND ${CMAKE_MAKE_PROGRAM} package_source)
 
 ################################################################################
 # Build the utilities                                                          #
 ################################################################################
 
-add_subdirectory(utils)
+if(NOT SKBUILD)
+  add_subdirectory(utils)
+endif(NOT SKBUILD)