scikit-build-core 0.1.0b0

Build backend for CMake based projects

scikit-build-core

WARNING: Only the pyproject-based builder should be used (setuptools backend is experimental and likely to move to a separate package), and internal API is still being solidified. A future version of this package will support creating new build extensions.

The following limitations are present compared to classic scikit-build:

• The minimum supported CMake is 3.15
• The minimum supported Python is 3.7

Some know missing features that will be developed soon:

• No support for caching between builds
• No editable mode support
• The docs are not written
• Dedicated entrypoints are planned for projects wanting to support discovery
• No support for other targets besides install
• C++17 is required for the test suite because it's more fun than C++11/14
• Wheels are not fully reproducible yet
• Windows ARM support missing

Other backends are also planned:

• Setuptools integration highly experimental currently
• The extensionlib integration is missing
• No hatchling plugin yet

Features over classic Scikit-build:

• Better warnings, errors, and logging
• No warning about unused variables
• Automatically adds Ninja and/or CMake only as required
• No dependency on setuptools, distutils, or wheel in build mode.
• Powerful config system, including config options support in build mode.
• Automatic inclusion of site-packages in CMAKE_PREFIX_PATH
• FindPython is backported if running on CMake < 3.24 (included via hatchling in a submodule)
• Limited API / Stable ABI and pythonless tags supported via config option
• No slow generator search, ninja/make or MSVC used by default, respects CMAKE_GENERATOR
• SDists are reproducible by default (UNIX, Python 3.9+)

Currently, the recommended interface is the PEP 517 interface. There is also a setuptools-based interface that is being developed to provide a transition path for classic scikit-build.

Example

To use scikit-build-core, add it to your build-system.requires, and specify the scikit_build_core.build builder as your build-system.build-backend. You do not need to specify cmake or ninja; scikit-build-core will require them automatically if the system versions are not sufficient.

[build-system]
requires = ["scikit-build-core"]
build-backend = "scikit_build_core.build"

[project]
name = "scikit_build_simplest"
version = "0.0.1"

You can (and should) specify the rest of the entries in project, but these are the minimum to get started. You can also add the color (more colorful printouts) or pyproject (pre-load some dependencies) extras if you want.

An example CMakeLists.txt:

cmake_minimum_required(VERSION 3.15...3.24)

project(${SKBUILD_PROJECT_NAME} LANGUAGES C VERSION ${SKBUILD_PROJECT_VERSION})

find_package(Python COMPONENTS Interpreter Development.Module)

Python_add_library(_module MODULE src/module.c WITH_SOABI)
set(Python_SOABI ${SKBUILD_SOABI})  # Required for PyPy support

install(TARGETS _module DESTINATION ${SKBUILD_PROJECT_NAME})

Scikit-build-core will backport FindPython from CMake 3.24 to older versions of Python, and will handle PyPy for you if you are building from PyPy. You will need to install everything you want into the full final path inside site-modules (so you will usually prefix everything by the package name).

More examples are in the tests/packages.

Configuration

All configuration options can be placed in pyproject.toml, passed via -C options in pip or build (warning: pip doesn't support list options), or set as environment variables. tool.scikit-build is used in toml, skbuild. for -C options, or SKBUILD_* for environment variables. The defaults are listed below:

[tool.scikit-build]
# The PEP 517 build hooks will add ninja and/or cmake if the versions on the
# system are not at least these versions. Disabled by an empty string.
cmake.minimum-version = "3.15"
ninja.minimum-version = "1.5"

# Fallback on gmake/make if available and ninja is missing (Unix). Will only
# fallback on platforms without a known ninja wheel.
ninja.make-fallback = true

# Extra args for CMake. Pip, unlike build, does not support lists, so simicolon
# can be used to separate. Setting this in config or envvar will override the
# entire list). See also cmake.define.
cmake.args = []

# This activates verbose builds
cmake.verbose = false

# This controls the CMake build type
build_type = "Release"

# Display logs at or above this level.
logging.level = "WARNING"

# Include and exclude patterns, in gitignore syntax. Include overrides exclude.
# Wheels include packages included in the sdist; CMake has the final say.
sdist.include = []
sdist.exclude = []

# Make reproducible SDists (Python 3.9+ and UNIX recommended). Respects
# SOURCE_DATE_EPOCH when true (the default).
sdist.reproducible = true

# The root-level packages to include. Special default: if not given, the package
# is auto-discovered if it's name matches the main name.
wheel.packages = ["src/<package>", "<package>"]

# Setting py-api to "cp37" would build ABI3 wheels for Python 3.7+.  If CPython
# is less than this value, or on PyPy, this will be ignored.  Setting the api to
# "py3" or "py2.py3" would build wheels that don't depend on Python (ctypes,
# etc).
wheel.py-api = ""

# Setting this to true will expand tags (universal2 will add Intel and Apple
# Silicon tags, for pip <21.0.1 compatibility).
wheel.expand-macos-universal-tags = false

# This allows you to change the install dir, such as to the package name. The
# original dir is still at SKBUILD_PLATLIB_DIR (also SKBUILD_DATA_DIR, etc. are
# available)
wheel.install-dir = "."

# Enable experimental features if any are available
experimental = false

# Strictly validate config options
strict-config = true

# This provides some backward compatibility if set. Defaults to the latest
# scikit-build-core version.
minimum-version = "0.1"  # current version

[tool.scikit-build.cmake.define]
# Put CMake defines in this table.

Most CMake environment variables should be supported, and CMAKE_ARGS can be used to set extra CMake args. ARCHFLAGS is used to specify macOS universal2 or cross-compiles, just like setuptools.

Acknowledgements

Support for this work was provided by NSF cooperative agreement OAC-2209877.