[Python] Bundle FESAPI DLL import library into Windows wheel

Windows wheel CI: copy generated .lib files from fesapi-install/lib into the Release build folder so they are available during wheel repair. Update the CIBW_REPAIR_WHEEL_COMMAND_WINDOWS to include --include-imports for delvewheel (keeping --namespace-pkg) so imported DLLs are bundled into the repaired wheel.

Author: philippeVerney

.github/workflows/github-actions.yml

@@ -144,17 +144,18 @@ jobs:
         env:
           CIBW_BUILD: cp38-win_amd64 cp39-win_amd64 cp310-win_amd64 cp311-win_amd64 cp312-win_amd64 cp313-win_amd64
           CIBW_ARCHS: auto64
-          CIBW_BEFORE_ALL: >
+          CIBW_BEFORE_ALL_WINDOWS: >
             %VCPKG_INSTALLATION_ROOT%\vcpkg install boost-uuid minizip hdf5[zlib] &&
-            cd ${{ runner.temp }} &&
+            cd %RUNNER_TEMP% &&
             mkdir fesapi-build &&
             cd fesapi-build &&
-            cmake -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALLATION_ROOT%\scripts\buildsystems\vcpkg.cmake -G"Visual Studio 17 2022" -A x64 -T host=x64 -Wno-dev -Wno-deprecated -DWITH_PYTHON_WRAPPING=TRUE -DCMAKE_INSTALL_PREFIX=${{ runner.temp }}/fesapi-install ${{ github.workspace }} &&
+            cmake -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALLATION_ROOT%\scripts\buildsystems\vcpkg.cmake -G"Visual Studio 17 2022" -A x64 -T host=x64 -Wno-dev -Wno-deprecated -DWITH_PYTHON_WRAPPING=TRUE -DCMAKE_INSTALL_PREFIX=%RUNNER_TEMP%/fesapi-install ${{ github.workspace }} &&
             cmake --build . --config Release -j2 &&
             cmake --build . --config Release --target INSTALL &&
+            copy "%RUNNER_TEMP%/fesapi-install/lib/*.lib" "%RUNNER_TEMP%/fesapi-build/Release" &&
             pip install delvewheel
           CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: >
-            delvewheel repair --add-path ${{ runner.temp }}\fesapi-build\Release --namespace-pkg fesapi -w {dest_dir} {wheel}
+            delvewheel repair --add-path %RUNNER_TEMP%\fesapi-build\Release --include-imports --namespace-pkg fesapi -w {dest_dir} {wheel}
           CIBW_TEST_COMMAND: python ${{github.workspace}}\python\example\example.py
         with:
           package-dir: ./python

python/example/fesapi.ipynb

@@ -2,24 +2,24 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "40a17e1f-53f0-4ec9-b2a4-2718acf2a59e",
+   "id": "0",
    "metadata": {},
    "source": [
     "The very first step is to download and install the FESAPI wheel : pip install fesapi"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "a16222c5-064e-431d-9dae-d3d6c535a6b9",
+   "id": "1",
    "metadata": {},
    "source": [
     "Once FESAPI wheel installed, you need to first import it in order to be able to call its API (https://www.f2i-consulting.com/fesapi/doxygen/)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "id": "fe2772db-0f12-4ba3-bd7c-17890092dc63",
+   "execution_count": null,
+   "id": "2",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -28,16 +28,16 @@
   },
   {
    "cell_type": "markdown",
-   "id": "0e0f0067-7c3e-4b4f-9da9-b6a4da7f8929",
+   "id": "3",
    "metadata": {},
    "source": [
     "Let's now create a DataObjectRepository in order to store Energistics dataobjects in-memory."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
-   "id": "6d5cda5b-7627-4405-a4c0-ced8edbe9257",
+   "execution_count": null,
+   "id": "4",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -46,16 +46,16 @@
   },
   {
    "cell_type": "markdown",
-   "id": "d7d5c21e-8b14-4bd6-a78f-d0bef5014e4f",
+   "id": "5",
    "metadata": {},
    "source": [
     "Energistics local CRS and Energistics HDF Proxy dataobjects are respectively required when we want to export CRS aware dataobjects and RESQML2 representations. Let's create them and set them as default ones for all other Energistics dataobject we will create later."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "id": "5c3e7a41-5270-4a06-9125-af784c097f17",
+   "execution_count": null,
+   "id": "6",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -76,16 +76,16 @@
   },
   {
    "cell_type": "markdown",
-   "id": "dcfbaeab-a787-47ff-b323-437bb3b556df",
+   "id": "7",
    "metadata": {},
    "source": [
     "We can now create plenty of Energistics dataobjects. Let's try a Horizon 2d grid."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
-   "id": "a987ec54-86a8-424f-9539-48b87a9e8dea",
+   "execution_count": null,
+   "id": "8",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -96,7 +96,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "b564949a-03b8-4988-b4d8-c779b2f3fe2a",
+   "id": "9",
    "metadata": {},
    "source": [
     "And let's set a 2x3 geometry on this 2d grid where the Z values equal hundred times the node index.\n",
@@ -108,8 +108,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
-   "id": "c6245f4b-5acd-454b-921d-99e767c36c79",
+   "execution_count": null,
+   "id": "10",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -124,25 +124,27 @@
   },
   {
    "cell_type": "markdown",
-   "id": "0580e85e-0040-423c-8825-ebfb511ba26f",
+   "id": "11",
    "metadata": {},
    "source": [
     "We can now serialize our DataObjectRepository into an EPC document in order to share it with other EPC aware application."
    ]
   },
   {
    "cell_type": "code",
-   "id": "b5d289e6-c699-4d88-a870-3dae2baf14ee",
+   "execution_count": null,
+   "id": "12",
    "metadata": {},
+   "outputs": [],
    "source": [
-    "# Create an EPC Document in the current folder nad named TestingFesapiWithPython.epc\n",
+    "# Create an EPC Document named TestingFesapiWithPython.epc in the current folder\n",
     "epc_file = fesapi.EpcDocument(file_name_without_extension + \".epc\")\n",
     "epc_file.serializeFrom(repo)"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "6614030b",
+   "id": "13",
    "metadata": {},
    "source": [
     "We can clear the repository to clean in memory repository and release HDF5 files."
@@ -151,7 +153,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "df354cf5",
+   "id": "14",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -161,7 +163,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv (3.11.9)",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -175,7 +177,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.9"
+   "version": "3.8"
   }
  },
  "nbformat": 4,