VTK-SDK Python Helper

VTK-SDK Python Helper is a collection of CMake modules to help you build VTK-compatible wheels using the VTK-SDK!

It is distributed as a Python package, used as a build-requirements for project builds using scikit-build-core. See Usage section for more information.

Features

High-level CMake functions to build VTK modules in a wheel compatible with VTK wheel using the VTK-SDK:

• Build VTK based modules using a high-level API, compatible with any VTK version >= 9.6.0.
• Generate a package init correctly initializing your module against VTK.
• Generate a SDK version of your project to then build other VTK modules against it. You can "chain" projects using this.
• Package native runtime dependencies

Usage

Add vtk-sdk-python-wheel-helper to your build requirements, with scikit-build-core build-system:

[build-system]
requires = [
    "scikit-build-core",
    "vtk-sdk==X.Y.Z", # Version of "vtk-sdk" should always be specified using "==X.Y.Z" and match the one associated with the "vtk" dependency below.
    "vtk-sdk-python-wheel-helper" # you can use the latest version, it supports VTK 9.6.0 and newer.
]
build-backend = "scikit_build_core.build"

vtk-sdk-python-wheel-helper package adds an entry to CMAKE_MODULE_PATH variable, so you can directly include it:

include(VTKSDKPythonWheelHelper)

vtk-sdk adds a path to CMAKE_PREFIX_PATH, this enables VTKSDKPythonWheelHelper to find VTK automatically. Then you get access to the helper's functions, for example:

vtksdk_build_modules(${SKBUILD_PROJECT_NAME} MODULES SuperProject::AmazingModule)
vtksdk_generate_package_init(${SKBUILD_PROJECT_NAME} MODULES SuperProject::AmazingModule)

See tests/BasicProject for more information about building your own module and SDK. See tests/packages/build_module for more information about building your own modules against your own SDK!

Other usage example can be found on SlicerCore repository.

Documentation

CMake functions documentation can be found in the CMake files and online @ https://vtk-sdk-python-wheel-helper.readthedocs.io/en/latest

Future work

• Support PYI generation using VTK helper script
• Support debug symbol wheel generation

License

Apache License, Version 2.0. See LICENSE file for details.