Generate Python wheels in CI

.github/workflows/python.yml

@@ -0,0 +1,132 @@
+name: python
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  # Generate the sdist first. We'll use it to create the wheels.
+  # https://packaging.python.org/en/latest/flow#the-source-distribution-sdist
+  sdist:
+    name: Generate Source Distribution
+    runs-on: ubuntu-latest
+    outputs:
+      sdist_filename: ${{ steps.generate.outputs.filename }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: Install Build Command
+      run: python -m pip install build
+
+    - name: Generate Sdist
+      id: generate
+      run: |
+        python -m build -s . --outdir dist
+        echo "filename=$(ls dist)" >> "$GITHUB_OUTPUT"
+
+    - name: Upload Sdist
+      uses: actions/upload-artifact@v3
+      with:
+        name: sdist
+        path: ./dist/*.tar.gz
+
+  # Create the wheels. It'll use the sdist to confirm that we can compile MaterialX from the sdist.
+  # https://packaging.python.org/en/latest/flow#the-built-distributions-wheels
+  wheels:
+    name: Generate Wheel
+    runs-on: ${{ matrix.os }}
+    needs: ['sdist']
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['37', '38', '39', '310', '311']
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+
+    steps:
+    - name: Download Sdist
+      uses: actions/download-artifact@v3
+      with:
+        name: sdist
+        path: sdist
+
+    - name: Build Wheel
+      # https://cibuildwheel.readthedocs.io/en/stable/
+      uses: pypa/[email protected]
+      with:
+        # Build from the sdist. We want to make sure it's valid and works as expected.
+        package-dir: ${{ github.workspace }}/sdist/${{ needs.sdist.outputs.sdist_filename }}
+        output-dir: wheels
+      env:
+        CIBW_BUILD: 'cp${{ matrix.python-version }}-*'
+        CIBW_SKIP: '*musllinux*'
+        CIBW_ARCHS: 'auto64'
+        # https://github.com/pypa/manylinux
+        # manylinux2014 is CentOS 7 based. Which means GCC 10 and glibc 2.17.
+        CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
+        CIBW_BEFORE_ALL_LINUX: yum install -y libXt-devel
+        CIBW_BEFORE_ALL_MACOS: sudo xcode-select -switch /Applications/Xcode_13.4.app
+        CIBW_BUILD_VERBOSITY: 1
+        CIBW_ENVIRONMENT: CMAKE_BUILD_PARALLEL_LEVEL=2
+        # CIBW_BUILD_FRONTEND: build  # https://github.com/pypa/build
+        MACOSX_DEPLOYMENT_TARGET: '10.15'
+
+    - name: Upload Wheel
+      uses: actions/upload-artifact@v3
+      with:
+        name: wheels
+        path: ./wheels/*.whl
+
+  test:
+    name: Test Wheel
+    needs: ['wheels']
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Download Wheels
+      uses: actions/download-artifact@v3
+      with:
+        name: wheels
+        path: wheels
+
+    - name: Install Wheel
+      run: python -m pip install MaterialX --find-links wheels --no-index
+
+    - name: Python Tests
+      shell: bash
+      run: |
+        set -e
+        python python/MaterialXTest/main.py
+        python python/MaterialXTest/genshader.py
+        python python/Scripts/mxformat.py ./resources/Materials/TestSuite/stdlib/upgrade --yes --upgrade
+        python python/Scripts/mxvalidate.py ./resources/Materials/Examples/StandardSurface/standard_surface_marble_solid.mtlx --stdlib --verbose
+        python python/Scripts/mxdoc.py --docType md ./libraries/pbrlib/pbrlib_defs.mtlx
+        python python/Scripts/mxdoc.py --docType html ./libraries/bxdf/standard_surface.mtlx
+        python python/Scripts/generateshader.py ./resources/Materials/Examples/StandardSurface --target glsl
+        python python/Scripts/generateshader.py ./resources/Materials/Examples/StandardSurface --target osl
+        python python/Scripts/generateshader.py ./resources/Materials/Examples/StandardSurface --target mdl
+        python python/Scripts/generateshader.py ./resources/Materials/Examples/StandardSurface --target msl

.gitignore

@@ -1 +1,2 @@
 build
+/dist

CMakeLists.txt

@@ -31,7 +31,9 @@ if (MATERIALX_BUILD_JS)
     endif()
 endif()
 
-project(MaterialX)
+project(MaterialX
+    VERSION ${MATERIALX_LIBRARY_VERSION}
+)
 
 option(MATERIALX_BUILD_PYTHON "Build the MaterialX Python package from C++ bindings. Requires Python 3.6 or greater." OFF)
 option(MATERIALX_BUILD_VIEWER "Build the MaterialX Viewer." OFF)
@@ -80,6 +82,12 @@ set(MATERIALX_OSL_BINARY_OSLC "" CACHE FILEPATH "Full path to the OSL compiler b
 set(MATERIALX_OSL_BINARY_TESTRENDER "" CACHE FILEPATH "Full path to the OSL test render binary.")
 set(MATERIALX_OSL_INCLUDE_PATH "" CACHE PATH "Full path to OSL shader includes (e.g. 'stdosl.h').")
 
+set(MATERIALX_PYTHON_FOLDER_NAME "python/MaterialX" CACHE INTERNAL "Folder name to user for installing the Python library.")
+
+if(SKBUILD)
+    set(MATERIALX_PYTHON_FOLDER_NAME "MaterialX")
+endif()
+
 # Helpers for MDL validation
 if (MATERIALX_BUILD_GEN_MDL)
     set(MATERIALX_MDLC_EXECUTABLE "" CACHE FILEPATH "Full path to the mdlc binary.")
@@ -277,7 +285,7 @@ if(MATERIALX_BUILD_RENDER)
     if(MATERIALX_BUILD_GRAPH_EDITOR)
         add_subdirectory(source/MaterialXGraphEditor)
     endif()
-    if(MATERIALX_INSTALL_RESOURCES)
+    if(MATERIALX_INSTALL_RESOURCES AND NOT SKBUILD)
         add_subdirectory(resources)
     endif()
 endif()
@@ -312,26 +320,28 @@ if(${CMAKE_VERSION} VERSION_GREATER "3.6.2")
 endif()
 
 # Install root-level documents
-install(FILES LICENSE CHANGELOG.md README.md THIRD-PARTY.md
-        DESTINATION .)
-
-set(MATERIALX_GEN_CONFIG_PATH "${MATERIALX_INSTALL_LIB_PATH}/cmake/${CMAKE_PROJECT_NAME}")
-
-include(CMakePackageConfigHelpers)
-configure_package_config_file(cmake/modules/MaterialXConfig.cmake.in
-                              ${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}Config.cmake
-                              INSTALL_DESTINATION "${MATERIALX_GEN_CONFIG_PATH}"
-                              PATH_VARS CMAKE_INSTALL_PREFIX CMAKE_PROJECT_NAME)
-write_basic_package_version_file(${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
-                                 VERSION ${MATERIALX_LIBRARY_VERSION}
-                                 COMPATIBILITY AnyNewerVersion)
-
-# Install the auto-generated CMake configuration files:
-
-install(EXPORT MaterialX
-        DESTINATION "${MATERIALX_GEN_CONFIG_PATH}"
-        FILE ${CMAKE_PROJECT_NAME}Targets.cmake)
-
-install(FILES "${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}ConfigVersion.cmake"
-        "${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}Config.cmake"
-        DESTINATION "${MATERIALX_GEN_CONFIG_PATH}")
+if(NOT SKBUILD)
+    install(FILES LICENSE CHANGELOG.md README.md THIRD-PARTY.md
+            DESTINATION .)
+
+    set(MATERIALX_GEN_CONFIG_PATH "${MATERIALX_INSTALL_LIB_PATH}/cmake/${CMAKE_PROJECT_NAME}")
+
+    include(CMakePackageConfigHelpers)
+    configure_package_config_file(cmake/modules/MaterialXConfig.cmake.in
+                                ${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}Config.cmake
+                                INSTALL_DESTINATION "${MATERIALX_GEN_CONFIG_PATH}"
+                                PATH_VARS CMAKE_INSTALL_PREFIX CMAKE_PROJECT_NAME)
+    write_basic_package_version_file(${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
+                                    VERSION ${MATERIALX_LIBRARY_VERSION}
+                                    COMPATIBILITY AnyNewerVersion)
+
+    # Install the auto-generated CMake configuration files:
+
+    install(EXPORT MaterialX
+            DESTINATION "${MATERIALX_GEN_CONFIG_PATH}"
+            FILE ${CMAKE_PROJECT_NAME}Targets.cmake)
+
+    install(FILES "${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}ConfigVersion.cmake"
+            "${CMAKE_BINARY_DIR}/cmake/${CMAKE_PROJECT_NAME}Config.cmake"
+            DESTINATION "${MATERIALX_GEN_CONFIG_PATH}")
+endif()

libraries/CMakeLists.txt

@@ -1,20 +1,26 @@
-install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
-        DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}" MESSAGE_NEVER
-        PATTERN "CMakeLists.txt" EXCLUDE
-        PATTERN "pbrlib_genosl_impl.*" EXCLUDE)
-
 if (MATERIALX_OSL_LEGACY_CLOSURES)
     set(PBRLIB_SUFFIX "legacy")
 else()
     set(PBRLIB_SUFFIX "mtlx")
 endif()
 
-install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pbrlib/genosl/pbrlib_genosl_impl.${PBRLIB_SUFFIX}"
-        DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)
+if(NOT SKBUILD)
+    install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
+            DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}"
+            PATTERN "CMakeLists.txt" EXCLUDE
+            PATTERN "pbrlib_genosl_impl.*" EXCLUDE)
+    install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pbrlib/genosl/pbrlib_genosl_impl.${PBRLIB_SUFFIX}"
+            DESTINATION "${MATERIALX_INSTALL_STDLIB_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)
+endif()
+
+set(MATERIALX_PYTHON_LIBRARIES_PATH "${MATERIALX_PYTHON_FOLDER_NAME}/${MATERIALX_INSTALL_STDLIB_PATH}")
+if(SKBUILD)
+    set(MATERIALX_PYTHON_LIBRARIES_PATH "${SKBUILD_PLATLIB_DIR}/MaterialX/libraries")
+endif()
 
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/
-        DESTINATION "python/MaterialX/${MATERIALX_INSTALL_STDLIB_PATH}" 
+        DESTINATION "${MATERIALX_PYTHON_LIBRARIES_PATH}"
         PATTERN "CMakeLists.txt" EXCLUDE
         PATTERN "pbrlib_genosl_impl.*" EXCLUDE)
 install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/pbrlib/genosl/pbrlib_genosl_impl.${PBRLIB_SUFFIX}"
-        DESTINATION "python/MaterialX/${MATERIALX_INSTALL_STDLIB_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)
+        DESTINATION "${MATERIALX_PYTHON_LIBRARIES_PATH}/pbrlib/genosl/" RENAME pbrlib_genosl_impl.mtlx)

mtx_skbuild_plugin.py

@@ -0,0 +1,90 @@
+"""
+This is a custom scikit-build-core plugin that will
+fetch the MaterialX version from the CMake project.
+"""
+import os
+import tempfile
+import subprocess
+from pathlib import Path
+from typing import FrozenSet, Dict, Optional, Union, List
+
+from scikit_build_core.file_api.query import stateless_query
+from scikit_build_core.file_api.reply import load_reply_dir
+
+
+def dynamic_metadata(
+    fields: FrozenSet[str],
+    settings: Optional[Dict[str, object]] = None,
+) -> Dict[str, Union[str, Dict[str, Optional[str]]]]:
+    print("mtx_skbuild_plugin: Computing MaterialX version from CMake...")
+
+    if fields != {"version"}:
+        msg = "Only the 'version' field is supported"
+        raise ValueError(msg)
+
+    if settings:
+        msg = "No inline configuration is supported"
+        raise ValueError(msg)
+
+    current_dir = os.path.dirname(__file__)
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        # We will use CMake's file API to get the version
+        # instead of parsing the CMakeLists files.
+
+        # First generate the query folder so that CMake can generate replies.
+        reply_dir = stateless_query(Path(tmpdir))
+
+        # Run cmake (configure). CMake will generate a reply automatically.
+        try:
+            subprocess.run(
+                [
+                    "cmake",
+                    "-S",
+                    current_dir,
+                    "-B",
+                    tmpdir,
+                    "-DMATERIALX_BUILD_SHARED_LIBS=OFF",
+                    "-DMATERIALX_BUILD_PYTHON=OFF",
+                    "-DMATERIALX_TEST_RENDER=OFF",
+                    "-DMATERIALX_BUILD_TESTS=OFF",
+                    "-DMATERIALX_INSTALL_PYTHON=OFF",
+                    "-DMATERIALX_BUILD_RENDER=OFF",
+                ],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+                check=True,
+                text=True,
+            )
+        except subprocess.CalledProcessError as exc:
+            print(exc.stdout)
+            raise RuntimeError(
+                "Failed to configure project to get the version"
+            ) from exc
+
+        # Get the generated replies.
+        index = load_reply_dir(reply_dir)
+
+        # Get the version from the CMAKE_PROJECT_VERSION variable.
+        entries = [
+            entry
+            for entry in index.reply.cache_v2.entries
+            if entry.name == "CMAKE_PROJECT_VERSION"
+        ]
+
+        if not entries:
+            raise ValueError("Could not find MaterialX version from CMake project")
+
+        if len(entries) > 1:
+            raise ValueError("More than one entry for CMAKE_PROJECT_VERSION found...")
+
+    version = entries[0].value
+    print("mtx_skbuild_plugin: Computed version: {0}".format(version))
+
+    return {"version": version}
+
+
+def get_requires_for_dynamic_metadata(
+    _settings: Optional[Dict[str, object]] = None,
+) -> List[str]:
+    return ["cmake"]