Scikit-build

0.19.0 · active · verified Sat Apr 11

Scikit-build is a Python build system that acts as a glue layer between `setuptools` and `CMake` to facilitate the building of CPython C/C++/Fortran/Cython extensions. It is currently at version 0.19.0 and has an active development cycle, with a focus on fixing bugs and improving compatibility. The next generation, `scikit-build-core`, is under active development and offers a more modern, standalone approach without direct reliance on `setuptools`.

Warnings

breaking Python 3.7 support was dropped in scikit-build 0.19.0. Ensure your projects target Python 3.8 or newer.
Fix: Upgrade Python environment to 3.8+.
breaking Scikit-build 0.19.0 includes updates for changes in newer `setuptools` versions (e.g., setuptools 74) and `CMake 4`. The `dry-run` option was also removed due to setuptools changes. Older versions of setuptools may no longer be compatible.
Fix: Ensure `setuptools` is updated to a compatible version (>=74 is explicitly mentioned for 0.18.1, so likely higher for 0.19.0) and consider upgrading `CMake` to version 4 or newer.
gotcha Scikit-build is the 'classic' setuptools-based integration. For new projects, consider `scikit-build-core`, which is a ground-up rewrite that acts as a standalone build backend without direct `setuptools` dependency and offers improved features and stability.
Fix: For new projects, evaluate `scikit-build-core`. If sticking with `scikit-build`, be aware of its tighter coupling with `setuptools`.
gotcha Editable installs using `scikit-build` (classic) often do not work correctly with recent versions of `setuptools`.
Fix: Avoid editable installs, or be prepared for potential issues. `scikit-build-core` aims to address this with experimental editable mode support.
gotcha The `_skbuild` cache directory may need to be manually deleted between builds, especially if changing the Python interpreter or encountering unexpected build issues.
Fix: Manually delete the `_skbuild` directory if facing build problems or switching environments.
breaking Minimum required CMake version is 3.5 since scikit-build 0.18.0. Additionally, older CMake versions (<3.24) may break when a library is specified, as fixed in 0.17.1.
Fix: Ensure CMake version is 3.18 or higher (as recommended in examples for 0.19.0) and ideally 3.24+ to avoid potential issues with library specification.
deprecated The behavior of directly driving the CMake build of a module via `setup.py` (`python setup.py build_ext --inplace`) is considered legacy and is no longer the recommended approach. Scikit-build's primary utility is driving the generation of Python distributables for PyPI.
Fix: Focus on using `scikit-build` for generating distributable packages (wheels/sdists) rather than direct `build_ext --inplace` invocations. Use PEP 517/518 compliant build processes (e.g., `pip install .` or `python -m build`).

Install

pip install scikit-build Install latest version

Imports

setup
```
from skbuild import setup
```
Scikit-build's `setup` function replaces setuptools' `setup` to integrate CMake build logic.

Quickstart

To use scikit-build, you typically define your build requirements in `pyproject.toml`, replace `setuptools.setup` with `skbuild.setup` in your `setup.py`, and provide a `CMakeLists.txt` to describe how to build your C/C++/Fortran/Cython extensions. The `packages` argument in `setup()` helps scikit-build locate your Python modules, which will then be combined with artifacts built by CMake. A simple `hello` subdirectory with `_hello.cxx` (your C++ source) and an empty `__init__.py` is a common starting point.

# pyproject.toml
[build-system]
requires = ["setuptools>=42", "scikit-build>=0.13", "cmake>=3.18", "ninja"]
build-backend = "setuptools.build_meta"

[project]
name = "hello-cpp"
version = "0.0.1"

# setup.py
# This file would be in the same directory as pyproject.toml
# In a 'hello' subdirectory, you would have a '_hello.cxx' and '__init__.py'
# In the project root, you would also have a 'CMakeLists.txt'

from skbuild import setup

setup(
    name="hello-cpp",
    version="0.0.1",
    description="A minimal C++ extension package using scikit-build",
    author='The scikit-build team',
    license="MIT",
    packages=['hello'],
    python_requires=">=3.8",
)

# CMakeLists.txt (example content, not runnable Python):
# cmake_minimum_required(VERSION 3.18...3.22)
# project(hello CXX)
# find_package(PythonExtensions REQUIRED)
# add_library(_hello MODULE hello/_hello.cxx)
# python_extension_module(_hello)
# install(TARGETS _hello LIBRARY DESTINATION hello)

view raw JSON →