feat: Python wheels workflow and build backend

.gitignore

@@ -4,13 +4,17 @@ branches/
 build/
 dist/
 ext/
+wheelhouse/
+_coverage/
+.python-version
 .idea
 .vscode
 .cproject
 .project
 .DS_Store
 *.pyc
-_coverage/
+/*.lock
+gastest.o
 
 # Exclude test files I tend to leave around at the top level. The leading
 # slash ensures that files with these extensions within subdirectories are not
@@ -21,3 +25,5 @@ _coverage/
 /*.jxl
 /*.tx
 /*.log
+
+

CMakeLists.txt

@@ -123,6 +123,8 @@ set (PLUGIN_SEARCH_PATH "" CACHE STRING "Default plugin search path")
 file (TO_NATIVE_PATH "${PLUGIN_SEARCH_PATH}" PLUGIN_SEARCH_PATH_NATIVE)
 set (CMAKE_DEBUG_POSTFIX "_d" CACHE STRING "Library naming postfix for Debug builds")
 
+
+
 if (CMAKE_UNITY_BUILD_BATCH_SIZE)
     set (UNITY_SMALL_BATCH_SIZE "${CMAKE_UNITY_BUILD_BATCH_SIZE}" CACHE STRING "Unity batch mode size for expensive files")
 else ()
@@ -169,6 +171,38 @@ include (compiler)
 # Dependency finding utilities and all dependency-related options
 include (dependency_utils)
 
+option (IGNORE_HOMEBREWED_DEPS "If ON, will ignore homebrew-installed dependencies" OFF)
+if (IGNORE_HOMEBREWED_DEPS)
+    # Define the list of prefixes to ignore
+    set (HOMEBREW_PREFIXES
+         /opt/homebrew
+         /usr/local
+         /usr/X11
+         /usr/X11R6
+         /opt/X11
+    )
+    message (STATUS "Ignoring Homebrew dependencies and adjusted environment and CMake variables accordingly.")
+    foreach (_cmake_var
+             CMAKE_SYSTEM_INCLUDE_PATH
+             CMAKE_SYSTEM_LIBRARY_PATH
+             CMAKE_PREFIX_PATH)
+        remove_prefixes_from_variable (CMAKE ${_cmake_var} "${HOMEBREW_PREFIXES}")
+    endforeach ()
+
+    # Adjust CMAKE_IGNORE_PATH
+    foreach (_prefix IN LISTS HOMEBREW_PREFIXES)
+        list (APPEND CMAKE_IGNORE_PATH
+              "${_prefix}"
+              "${_prefix}/lib"
+              "${_prefix}/bin"
+              "${_prefix}/include"
+             )
+    endforeach ()
+
+    message (STATUS "CMAKE_IGNORE_PATH: ${CMAKE_IGNORE_PATH}")
+endif ()
+
+
 # Utilities and options related to finding python and making python bindings
 include (pythonutils)
 
@@ -246,10 +280,16 @@ if (NOT EMBEDPLUGINS AND NOT BUILD_OIIOUTIL_ONLY)
     endforeach ()
 endif ()
 
-if (USE_PYTHON AND Python3_Development_FOUND AND NOT BUILD_OIIOUTIL_ONLY)
+
+if (WIN32)
+    set (_py_dev_found Python3_Development_FOUND)    
+else ()
+    set (_py_dev_found Python3_Development.Module_FOUND)
+endif ()
+if (USE_PYTHON AND ${_py_dev_found} AND NOT BUILD_OIIOUTIL_ONLY)
     add_subdirectory (src/python)
 else ()
-    message (STATUS "Not building Python bindings: USE_PYTHON=${USE_PYTHON}, Python3_Development_FOUND=${Python3_Development_FOUND}")
+    message (STATUS "Not building Python bindings: USE_PYTHON=${USE_PYTHON}, Python3_Development.Module_FOUND=${Python3_Development.Module_FOUND}")
 endif ()
 
 add_subdirectory (src/include)

INSTALL.md

@@ -230,19 +230,20 @@ Make targets you should know about:
 
 Additionally, a few helpful modifiers alter some build-time options:
 
-|  Target                   |  Command                                       |
-| ------------------------- | ---------------------------------------------- |
-| make VERBOSE=1 ...        |  Show all compilation commands                 |
-| make STOP_ON_WARNING=0    |  Do not stop building if compiler warns        |
-| make EMBEDPLUGINS=0 ...   |  Don't compile the plugins into libOpenImageIO |
-| make USE_OPENGL=0 ...     |  Skip anything that needs OpenGL               |
-| make USE_QT=0 ...         |  Skip anything that needs Qt                   |
-| make MYCC=xx MYCXX=yy ... |  Use custom compilers                          |
-| make USE_PYTHON=0 ...     |  Don't build the Python binding                |
-| make BUILD_SHARED_LIBS=0  |  Build static library instead of shared        |
-| make LINKSTATIC=1 ...     |  Link with static external libraries when possible |
-| make SOVERSION=nn ...     |  Include the specified major version number in the shared object metadata |
-| make NAMESPACE=name       |   Wrap everything in another namespace         |
+|  Target                       |  Command                                                                  |
+| ----------------------------- | ------------------------------------------------------------------------- |
+| make VERBOSE=1 ...            |  Show all compilation commands                                            |
+| make STOP_ON_WARNING=0        |  Do not stop building if compiler warns                                   |
+| make EMBEDPLUGINS=0 ...       |  Don't compile the plugins into libOpenImageIO                            |
+| make USE_OPENGL=0 ...         |  Skip anything that needs OpenGL                                          |
+| make USE_QT=0 ...             |  Skip anything that needs Qt                                              |
+| make MYCC=xx MYCXX=yy ...     |  Use custom compilers                                                     |
+| make USE_PYTHON=0 ...         |  Don't build the Python binding                                           |
+| make BUILD_SHARED_LIBS=0      |  Build static library instead of shared                                   |
+| make IGNORE_HOMEBREWED_DEPS=1 |  Ignore homebrew-managed dependencies                                     |
+| make LINKSTATIC=1 ...         |  Link with static external libraries when possible                        |
+| make SOVERSION=nn ...         |  Include the specified major version number in the shared object metadata |
+| make NAMESPACE=name           |  Wrap everything in another namespace                                     |
 
 The command 'make help' will list all possible options.
 
@@ -357,6 +358,28 @@ produce a dynamic-linked version.
 
 3. Execute the PowerShell command from where vcpkg is located in directory. ``vcpkg install openimageio``
 
+
+Python-based Builds and Installs
+--------------------------------
+
+**Installing from prebuilt binary distributions**
+
+If you're only interested in the Python module and the CLI tools, you can install with `pip` or `uv`:
+
+> ```pip install OpenImageIO```
+
+**Building and installing from source**
+
+If you have a C++ compiler installed, you can also use the Python build-backend to compile and install
+from source by navigating to the root of the repository and running: ```pip install .```
+
+This will download and install CMake and Ninja if necessary, and invoke the CMake build system; which,
+in turn, will build missing dependencies, compile OIIO, and install the Python module, the libraries, 
+the headers, and the CLI tools to a platform-specific, Python-specific location. 
+
+See the [scikit-build-core docs](https://scikit-build-core.readthedocs.io/en/latest/configuration.html#configuring-cmake-arguments-and-defines)
+for more information on customizing and overriding build-tool options and CMake arguments.
+
 Test Images
 -----------
 

Makefile

@@ -378,6 +378,7 @@ help:
 	@echo "      USE_NUKE=0               Don't build Nuke plugins"
 	@echo "      Nuke_ROOT=path           Custom Nuke installation"
 	@echo "      NUKE_VERSION=ver         Custom Nuke version"
+	@echo "      IGNORE_HOMEBREWED_DEPS=1 Don't use dependencies installed by Homebrew"
 	@echo "  OIIO build-time options:"
 	@echo "      INSTALL_PREFIX=path      Set installation prefix (default: ./${INSTALL_PREFIX})"
 	@echo "      NAMESPACE=name           Override namespace base name (default: OpenImageIO)"

pyproject.toml

@@ -0,0 +1,132 @@
+[project]
+name = "OpenImageIO"
+# The build backend ascertains the version from the CMakeLists.txt file.
+dynamic = ["version"]
+description = "Reading, writing, and processing images in a wide variety of file formats, using a format-agnostic API, aimed at VFX applications."
+authors = [
+    {name = "Larry Gritz", email = "[email protected]"},
+    {name = "OpenImageIO Contributors", email = "[email protected]"}
+]
+maintainers = [
+    {name = "OpenImageIO Contributors", email="[email protected]"},
+]
+readme = "README.md"
+license = {text = "Apache-2.0"}
+classifiers = [
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Multimedia :: Video :: Display",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">= 3.8"
+
+[project.urls]
+Homepage = "https://openimageio.org/"
+Source = "https://github.com/AcademySoftwareFoundation/OpenImageIO"
+Documentation = "https://docs.openimageio.org"
+Issues = "https://github.com/AcademySoftwareFoundation/OpenImageIO/issues"
+
+
+[project.scripts]
+# Use the convention below to expose CLI tools as Python scripts.
+maketx = "OpenImageIO:_command_line"
+oiiotool = "OpenImageIO:_command_line"
+
+[build-system]
+build-backend = "scikit_build_core.build"
+requires = [
+    "scikit-build-core>=0.10.6,<1",
+    "pybind11",
+]
+
+[tool.scikit-build]
+build.verbose = true
+# Exclude unnecessary directories from the source distribution.
+sdist.exclude = [".github", "testsuite", "ASWF", "docs"]
+# Pin minimum scikit-build-core to that specified in build-system.requires.
+minimum-version = "build-system.requires"
+# Pin minimum CMake version to that specified in CMakeLists.txt.
+cmake.version = "CMakeLists.txt"
+wheel.license-files = ["LICENSE.md", "THIRD-PARTY.md"]
+# Make sure the package is structured as expected.
+wheel.install-dir = "OpenImageIO"
+# Only install the user and fonts components.
+install.components = ["user", "fonts"]
+
+[tool.scikit-build.cmake.define]
+# Build missing dependencies. See src/cmake for details.
+OpenImageIO_BUILD_MISSING_DEPS = "all"
+# Don't build tests. Dramatically improves build time.
+OIIO_BUILD_TESTS = "0"
+# Prefer linking static dependencies when possible.
+LINKSTATIC = "1"
+# Standardize the install directory for libraries, as expected by
+# other parts of the wheels build process.
+CMAKE_INSTALL_LIBDIR = "lib"
+
+# Dynamically set the package version metadata by pasrsing CMakeLists.txt.
+[tool.scikit-build.metadata.version]
+provider = "scikit_build_core.metadata.regex"
+input = "CMakeLists.txt" 
+regex = 'set \(OpenImageIO_VERSION "(?P<value>[0-9a-z.]+)"\)'
+
+
+# On macOS, ensure dependencies are only built for the target architecture.
+[[tool.scikit-build.overrides]]
+if.platform-system = "darwin"
+if.platform-machine  = "arm64"
+inherit.cmake.define = "append"
+cmake.define.CMAKE_OSX_ARCHITECTURES = "arm64"
+
+[[tool.scikit-build.overrides]]
+if.platform-system = "darwin"
+if.platform-machine  = "x86_64"
+inherit.cmake.define = "append"
+cmake.define.CMAKE_OSX_ARCHITECTURES = "x86_64"
+
+
+[tool.cibuildwheel]
+build-verbosity = 1
+skip = [
+    # Skip 32-bit builds
+    "*-win32",
+    "*-manylinux_i686",
+    # Building with musl seems to work, but the repair-wheel step seems to fail...
+    # This may be a bug in repairwheel (or auditwheel)?
+    "*musllinux*",  
+]
+test-command = "oiiotool --buildinfo"
+# Prevent CIBW's default repair-wheel command from running, because it fails to
+# recognize that the wheel isn't broken to begin with, and ends up creating
+# additional copies of the shared libraries in the wheel.
+
+[tool.cibuildwheel.macos.environment]
+# Specify a persistent build directory so the repairwheel command can (re)find
+# dependency libraries built by OpenImageIO.
+SKBUILD_BUILD_DIR = "/tmp/build_oiio_wheels"
+# Always (re)build the TIFF library; see #4439 for more details.
+SKBUILD_CMAKE_ARGS = "-DOpenImageIO_BUILD_LOCAL_DEPS=TIFF; -DOpenImageIO_BUILD_MISSING_DEPS=all; -DLINKSTATIC=1; -DIGNORE_HOMEBREWED_DEPS=1; -DCMAKE_INSTALL_LIBDIR=lib"
+# C++17 - std::filesystem is only available in macOS 10.15 and later.
+MACOSX_DEPLOYMENT_TARGET = "11"
+# Optimize for size (not speed).
+SKBUILD_CMAKE_BUILD_TYPE = "MinSizeRel"
+
+[tool.cibuildwheel.linux.environment]
+SKBUILD_BUILD_DIR = "/tmp/build_oiio_wheels"
+SKBUILD_CMAKE_ARGS = "-DOpenImageIO_BUILD_LOCAL_DEPS=all; -DOpenImageIO_BUILD_MISSING_DEPS=all; -DLINKSTATIC=1; -DCMAKE_INSTALL_LIBDIR=lib"
+SKBUILD_CMAKE_BUILD_TYPE = "MinSizeRel"
+# Suppress warnings that cause linux cibuildwheel build to fail
+CXXFLAGS = "-Wno-error=stringop-overflow -Wno-pragmas"
+
+[tool.cibuildwheel.windows.environment]
+SKBUILD_CMAKE_BUILD_TYPE = "MinSizeRel"

src/build-scripts/build_libtiff.bash

@@ -45,6 +45,7 @@ if [[ -z $DEP_DOWNLOAD_ONLY ]]; then
                -Dtiff-tests=${LIBTIFF_BUILD_TESTS:-OFF} \
                -Dtiff-docs=${LIBTIFF_BUILD_TESTS:-OFF} \
                -Dlibdeflate=ON \
+               -Dwebp=OFF \ 
                ${LIBTIFF_BUILDOPTS}
     time cmake --build build --target install
 fi

src/cmake/build_OpenColorIO.cmake

@@ -39,6 +39,8 @@ build_dependency_with_cmake(OpenColorIO
         -D OCIO_BUILD_TESTS=OFF
         -D OCIO_USE_OIIO_FOR_APPS=OFF
         -D OCIO_INSTALL_DOCS=OFF
+        # Disable versioning in OCIO shared library name
+        -D OCIO_USE_SOVERSION=OFF
         # Make OCIO build all its dependencies statically
         -D OCIO_INSTALL_EXT_PACKAGES=MISSING
         # Give the library a custom name and symbol namespace so it can't

src/cmake/build_libdeflate.cmake

@@ -9,7 +9,7 @@
 set_cache (libdeflate_BUILD_VERSION 1.20 "libdeflate version for local builds")
 set (libdeflate_GIT_REPOSITORY "https://github.com/ebiggers/libdeflate")
 set (libdeflate_GIT_TAG "v${libdeflate_BUILD_VERSION}")
-set_cache (libdeflate_BUILD_SHARED_LIBS  ${LOCAL_BUILD_SHARED_LIBS_DEFAULT}
+set_cache (libdeflate_BUILD_SHARED_LIBS OFF # ${LOCAL_BUILD_SHARED_LIBS_DEFAULT}
            DOC "Should a local libdeflate build, if necessary, build shared libraries" ADVANCED)
 
 string (MAKE_C_IDENTIFIER ${libdeflate_BUILD_VERSION} libdeflate_VERSION_IDENT)
@@ -20,6 +20,7 @@ build_dependency_with_cmake(libdeflate
     GIT_TAG         ${libdeflate_GIT_TAG}
     CMAKE_ARGS
         -D BUILD_SHARED_LIBS=${libdeflate_BUILD_SHARED_LIBS}
+        -D LIBDEFLATE_BUILD_SHARED_LIB=${libdeflate_BUILD_SHARED_LIBS}
         -D CMAKE_POSITION_INDEPENDENT_CODE=ON
         -D CMAKE_INSTALL_LIBDIR=lib
         -D LIBDEFLATE_BUILD_GZIP=OFF
@@ -32,6 +33,7 @@ set (libdeflate_ROOT ${libdeflate_LOCAL_INSTALL_DIR})
 # Signal to caller that we need to find again at the installed location
 set (libdeflate_REFIND TRUE)
 set (libdeflate_REFIND_ARGS CONFIG)
+set (libdeflate_REFIND_VERSION ${libdeflate_BUILD_VERSION})
 
 if (libdeflate_BUILD_SHARED_LIBS)
     install_local_dependency_libs (libdeflate libdeflate)

src/cmake/compiler.cmake

@@ -655,7 +655,12 @@ if (CMAKE_SKIP_RPATH)
     unset (CMAKE_INSTALL_RPATH)
 else ()
     if (NOT CMAKE_INSTALL_RPATH)
-        set (CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_FULL_LIBDIR}")
+        if(APPLE)
+            set(BASEPOINT @loader_path)
+        else()
+            set(BASEPOINT $ORIGIN)
+        endif()
+        set (CMAKE_INSTALL_RPATH ${BASEPOINT} ${BASEPOINT}/${CMAKE_INSTALL_LIBDIR})
     endif ()
     # add the automatically determined parts of the RPATH that
     # point to directories outside the build tree to the install RPATH
@@ -679,9 +684,25 @@ set (CMAKE_EXPORT_COMPILE_COMMANDS ON)
 #    install_targets (target1 [target2 ...])
 #
 macro (install_targets)
-    install (TARGETS ${ARGN}
+    # Define options that can be passed to the macro
+    set(options NAMELINK_SKIP)
+
+    # Parse the arguments passed to the macro
+    cmake_parse_arguments(INSTALL_TARGETS "${options}" "" "" "${ARGN}")
+
+    # Check if NAMELINK_SKIP is specified
+    if (INSTALL_TARGETS_NAMELINK_SKIP)
+        # Set namelink_option to NAMELINK_SKIP if specified
+        set(namelink_option NAMELINK_SKIP)
+    else()
+        # Leave namelink_option empty if NAMELINK_SKIP is not specified
+        set(namelink_option)
+    endif()
+
+    # Use the install command with the appropriate options
+    install (TARGETS ${INSTALL_TARGETS_UNPARSED_ARGUMENTS}
              EXPORT ${PROJ_NAME}_EXPORTED_TARGETS
              RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" COMPONENT user
-             LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" COMPONENT user
+             LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" COMPONENT user ${namelink_option}
              ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}" COMPONENT developer)
 endmacro()