py-build-cmake
A modern, PEP 517 compliant build backend for creating Python packages with extensions built using CMake.
Features
- Building and packaging C, C++ or Fortran extension modules for Python using CMake
- Declarative configuration using
pyproject.toml(PEP 621) - Editable/development installations for Python modules (PEP 660)
- Easy integration with pybind11, nanobind and SWIG, with stable ABI support
- Stub generation for type checking and autocompletion
- Customizable CMake configuration, build, and installation options
- Support for installation of multiple configurations and components, across different Wheel packages
- First-class cross-compilation support
- Reproducible Wheels and source distributions
- No dependency on setuptools
- Compatible with cibuildwheel for building Wheels
Installation
The py-build-cmake package is available on PyPI:
pip install py-build-cmake
Documentation
The documentation can be found on https://tttapa.github.io/py-build-cmake.
The format of the configuration file is explained in Config.md.
Alternatively, use the command-line interface to get the documentation for all supported options:
py-build-cmake config format
To get started quickly, have a look at the following section and the README in
examples/minimal,
which goes over the project structure and the configuration files you'll need.
Usage
If you don't have one already, add a pyproject.toml configuration file to your
project's repository. Specify the mandatory project metadata (PyPA: Declaring project metadata),
and tell py-build-cmake how to build your CMake project. For example:
[project] # Project metadata
name = "example-project"
requires-python = ">=3.8"
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
dependencies = ["numpy"]
dynamic = ["version", "description"]
[build-system] # How pip and other frontends should build this project
requires = ["py-build-cmake~=0.5.1"]
build-backend = "py_build_cmake.build"
[tool.py-build-cmake.module] # Where to find the Python module to package
directory = "src-python"
[tool.py-build-cmake.sdist] # What to include in source distributions
include = ["CMakeLists.txt", "src/*"]
[tool.py-build-cmake.cmake] # How to build the CMake project
build_type = "RelWithDebInfo"
source_path = "src"
build_args = ["-j"]
install_components = ["python_modules"]
[tool.py-build-cmake.stubgen] # Whether and how to generate typed stub files
The README of examples/minimal
describes this configuration file in much more detail.
Then use pip, build
or another PEP 517 compatible frontend to build and/or install the package.
Build sdist and wheel packages you can upload to PyPI:
python -m pip install -U build
python -m build . # find the sdist and wheel file in the 'dist' folder
Install the package in the current environment:
pip install . # normal installation
pip install -e . # editable installation
Examples
As an introduction to py-build-cmake, see examples/minimal
for a detailed overview of the configuration files and the directory structure,
using a very simple Python module as an example.
For a more advanced, real-world example, see examples/pybind11-project
and examples/nanobind-project.
Alternatively, SWIG can also be used instead of pybind11 or nanobind, as
demonstrated in examples/swig-project.
If you are interested in packaging C/C++/Fortran programs using py-build-cmake,
have a look at examples/minimal-program.
See the examples folder for a full list of examples.
A full example that uses the Conan package manager for C++ dependencies, and that uses GitHub Actions to deploy the Wheel packages built by py-build-cmake to PyPI can be found in tttapa/py-build-cmake-example.
Projects using py-build-cmake
If you need more examples, you can look at the following projects using py-build-cmake as their Python build backend:
Alternatives and related tools
- scikit-build-core: alternative CMake build backend, successor of scikit-build
- meson-python: Meson build backend
- flit: pure-Python packaging tool and build backend
- hatchling: build backend of the Hatch project manager, supports build hooks
- poetry-core: pure-Python build backend for the Poetry package manager
- crossenv: tool to trick
setuptoolsinto cross-compiling by monkey patching thesysconfiganddistutilsmodules
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py_build_cmake-0.5.1.tar.gz.
File metadata
- Download URL: py_build_cmake-0.5.1.tar.gz
- Upload date:
- Size: 75.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31a83b12fcc5fddee4d84f36c2d9a2954eb1a7907f5a9cb06f439232859ce513
|
|
| MD5 |
67c4ed31d5d6daab9c6ff1b3b7814e52
|
|
| BLAKE2b-256 |
6d556334f07a7772620130feb1300db0ff39f5c9385e3e6a94090d800353e3f6
|
Provenance
The following attestation bundles were made for py_build_cmake-0.5.1.tar.gz:
Publisher:
wheel.yml on tttapa/py-build-cmake
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
py_build_cmake-0.5.1.tar.gz -
Subject digest:
31a83b12fcc5fddee4d84f36c2d9a2954eb1a7907f5a9cb06f439232859ce513 - Sigstore transparency entry: 2564865449
- Sigstore integration time:
-
Permalink:
tttapa/py-build-cmake@5369d24289af1f1e99bf1db373a26ad474bf360a -
Branch / Tag:
refs/tags/0.5.1 - Owner: https://github.com/tttapa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
wheel.yml@5369d24289af1f1e99bf1db373a26ad474bf360a -
Trigger Event:
release
-
Statement type:
File details
Details for the file py_build_cmake-0.5.1-py3-none-any.whl.
File metadata
- Download URL: py_build_cmake-0.5.1-py3-none-any.whl
- Upload date:
- Size: 97.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78d5f2117169644f44d0d99d3a5e97fa9dc0b1458d8eccb96c46b5e15fecb8e7
|
|
| MD5 |
a6f1184bd3c11f1d356e5dee9c97e663
|
|
| BLAKE2b-256 |
152558eb111c349f631f5a664c293dffdd6036197e70f818c2e198ae32e116ed
|
Provenance
The following attestation bundles were made for py_build_cmake-0.5.1-py3-none-any.whl:
Publisher:
wheel.yml on tttapa/py-build-cmake
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
py_build_cmake-0.5.1-py3-none-any.whl -
Subject digest:
78d5f2117169644f44d0d99d3a5e97fa9dc0b1458d8eccb96c46b5e15fecb8e7 - Sigstore transparency entry: 2564865481
- Sigstore integration time:
-
Permalink:
tttapa/py-build-cmake@5369d24289af1f1e99bf1db373a26ad474bf360a -
Branch / Tag:
refs/tags/0.5.1 - Owner: https://github.com/tttapa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
wheel.yml@5369d24289af1f1e99bf1db373a26ad474bf360a -
Trigger Event:
release
-
Statement type:
