conan-py-build

A PEP 517 build backend that uses Conan to build Python C/C++ extensions.

Documentation · PyPI · Examples

Install

pip install conan-py-build

Quick start

Note

The steps below use CMake, but the backend is build-system agnostic — it works with anything Conan can drive. For a Meson version, see basic-meson-pybind11.

1. Set conan-py-build as your build backend:

[build-system]
requires = ["conan-py-build"]
build-backend = "conan_py_build.build"

[project]
name = "mypackage"
version = "0.1.0"

2. Add a conanfile.py with your C++ dependencies:

from conan import ConanFile
from conan.tools.cmake import CMake, cmake_layout

class MyPackageConan(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeToolchain", "CMakeDeps"

    def layout(self):
        cmake_layout(self)

    def requirements(self):
        self.requires("fmt/12.1.0")

    def build(self):
        cmake = CMake(self)
        cmake.configure()
        cmake.build()

    def package(self):
        cmake = CMake(self)
        cmake.install()

3. Your CMakeLists.txt must install the extension into the package directory so it ends up in the wheel:

install(TARGETS _core DESTINATION mypackage)

4. Build:

pip wheel . -w dist/ -vvv

See the documentation for the full getting started guide, configuration, profiles, dynamic versioning, and more.

Examples

See the examples/ directory:

• basic — fmt extension, recipe via conanfile-path
• basic-pybind11 — pybind11 + fmt, dynamic version, PEP 639
• basic-meson-pybind11 — pybind11 + fmt built with Meson instead of CMake
• basic-nanobind — nanobind + fmt, extra-profile for C++17
• external-sources — pybind11, C++ dep fetched in source()
• cibw-example — pybind11 + cibuildwheel

License

MIT — see LICENSE.