cibuildwheel

Documentation

Python wheels are great. Building them across Mac, Linux, Windows, on multiple versions of Python, is not.

cibuildwheel is here to help. cibuildwheel runs on your CI server - currently it supports GitHub Actions, Azure Pipelines, Travis CI, CircleCI, and GitLab CI - and it builds and tests your wheels across all of your platforms.

What does it do?

While cibuildwheel itself requires a recent Python version to run (we support the last three releases), it can target the following versions to build wheels:

	macOS Intel	macOS Apple Silicon	Windows 64bit	Windows 32bit	Windows Arm64	manylinux musllinux x86_64	manylinux musllinux i686	manylinux musllinux aarch64	manylinux musllinux ppc64le	manylinux musllinux s390x	manylinux musllinux armv7l	Android	iOS	Pyodide
CPython 3.8	✅	✅	✅	✅	N/A	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	N/A
CPython 3.9	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	N/A
CPython 3.10	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	N/A
CPython 3.11	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	N/A
CPython 3.12	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	✅⁴
CPython 3.13³	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	✅	✅	N/A
CPython 3.14	✅	✅	✅	✅	✅²	✅	✅	✅	✅	✅	✅⁵	N/A	N/A	N/A
PyPy 3.8 v7.3	✅	✅	✅	N/A	N/A	✅¹	✅¹	✅¹	N/A	N/A	N/A	N/A	N/A	N/A
PyPy 3.9 v7.3	✅	✅	✅	N/A	N/A	✅¹	✅¹	✅¹	N/A	N/A	N/A	N/A	N/A	N/A
PyPy 3.10 v7.3	✅	✅	✅	N/A	N/A	✅¹	✅¹	✅¹	N/A	N/A	N/A	N/A	N/A	N/A
PyPy 3.11 v7.3	✅	✅	✅	N/A	N/A	✅¹	✅¹	✅¹	N/A	N/A	N/A	N/A	N/A	N/A
GraalPy 3.11 v24.2	✅	✅	✅	N/A	N/A	✅¹	N/A	✅¹	N/A	N/A	N/A	N/A	N/A	N/A

^{¹ PyPy & GraalPy are only supported for manylinux wheels.
² Windows arm64 support is experimental.
³ Free-threaded mode requires opt-in on 3.13 using enable.
⁴ Experimental, not yet supported on PyPI, but can be used directly in web deployment. Use --platform pyodide to build.
⁵ manylinux armv7l support is experimental. As there are no RHEL based image for this architecture, it's using an Ubuntu based image instead.}

• Builds manylinux, musllinux, macOS 10.9+ (10.13+ for Python 3.12+), and Windows wheels for CPython, PyPy, and GraalPy
• Works on GitHub Actions, Azure Pipelines, Travis CI, CircleCI, GitLab CI, and Cirrus CI
• Bundles shared library dependencies on Linux and macOS through auditwheel and delocate
• Runs your library's tests against the wheel-installed version of your library

See the cibuildwheel 1 documentation if you need to build unsupported versions of Python, such as Python 2.

Usage

cibuildwheel runs inside a CI service. Supported platforms depend on which service you're using:

	Linux	macOS	Windows	Linux ARM	macOS ARM	Windows ARM	Android	iOS
GitHub Actions	✅	✅	✅	✅	✅	✅²	✅⁴	✅³
Azure Pipelines	✅	✅	✅		✅	✅²	✅⁴	✅³
Travis CI	✅		✅	✅			✅⁴
CircleCI	✅	✅		✅	✅		✅⁴	✅³
Gitlab CI	✅	✅	✅	✅¹	✅		✅⁴	✅³
Cirrus CI	✅	✅	✅	✅	✅		✅⁴

^{¹ Requires emulation, distributed separately. Other services may also support Linux ARM through emulation or third-party build hosts, but these are not tested in our CI.
² Uses cross-compilation. It is not possible to test arm64 on this CI platform.
³ Requires a macOS runner; runs tests on the simulator for the runner's architecture.
⁴ Building for Android requires the runner to be Linux x86_64, macOS ARM64 or macOS x86_64. Testing has additional requirements.}

Example setup

To build manylinux, musllinux, macOS, and Windows wheels on GitHub Actions, you could use this .github/workflows/wheels.yml:

name: Build

on: [push, pull_request]

jobs:
  build_wheels:
    name: Build wheels on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm, macos-13, macos-latest]

    steps:
      - uses: actions/checkout@v4

      # Used to host cibuildwheel
      - uses: actions/setup-python@v5

      - name: Install cibuildwheel
        run: python -m pip install cibuildwheel==3.1.3

      - name: Build wheels
        run: python -m cibuildwheel --output-dir wheelhouse
        # to supply options, put them in 'env', like:
        # env:
        #   CIBW_SOME_OPTION: value
        #   ...

      - uses: actions/upload-artifact@v4
        with:
          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
          path: ./wheelhouse/*.whl

For more information, including PyPI deployment, and the use of other CI services or the dedicated GitHub Action, check out the documentation and the examples.

How it works

The following diagram summarises the steps that cibuildwheel takes on each platform.

^{Explore an interactive version of this diagram in the docs.}

	Option	Description
Build selection	platform	Override the auto-detected target platform
	build skip	Choose the Python versions to build
	archs	Change the architectures built on your machine by default.
	project-requires-python	Manually set the Python compatibility of your project
	enable	Enable building with extra categories of selectors present.
	allow-empty	Suppress the error code if no wheels match the specified build identifiers
Build customization	build-frontend	Set the tool to use to build, either "build" (default), "build[uv]", or "pip"
	config-settings	Specify config-settings for the build backend.
	environment	Set environment variables
	environment-pass	Set environment variables on the host to pass-through to the container.
	before-all	Execute a shell command on the build system before any wheels are built.
	before-build	Execute a shell command preparing each wheel's build
	xbuild-tools	Binaries on the path that should be included in an isolated cross-build environment.
	repair-wheel-command	Execute a shell command to repair each built wheel
	manylinux-*-image musllinux-*-image	Specify manylinux / musllinux container images
	container-engine	Specify the container engine to use when building Linux wheels
	dependency-versions	Control the versions of the tools cibuildwheel uses
	pyodide-version	Specify the Pyodide version to use for pyodide platform builds
Testing	test-command	The command to test each built wheel
	before-test	Execute a shell command before testing each wheel
	test-sources	Paths that are copied into the working directory of the tests
	test-requires	Install Python dependencies before running the tests
	test-extras	Install your wheel for testing using extras_require
	test-groups	Specify test dependencies from your project's dependency-groups
	test-skip	Skip running tests on some builds
	test-environment	Set environment variables for the test environment
Debugging	debug-keep-container	Keep the container after running for debugging.
	debug-traceback	Print full traceback when errors occur.
	build-verbosity	Increase/decrease the output of the build

These options can be specified in a pyproject.toml file, or as environment variables, see configuration docs.

Working examples

Here are some repos that use cibuildwheel.

Name	CI	OS	Notes
scikit-learn			The machine learning library. A complex but clean config using many of cibuildwheel's features to build a large project with Cython and C++ extensions.
pytorch-fairseq			Facebook AI Research Sequence-to-Sequence Toolkit written in Python.
duckdb			DuckDB is an analytical in-process SQL database management system
NumPy			The fundamental package for scientific computing with Python.
Tornado			Tornado is a Python web framework and asynchronous networking library. Uses stable ABI for a small C extension.
NCNN			ncnn is a high-performance neural network inference framework optimized for the mobile platform
Matplotlib			The venerable Matplotlib, a Python library with C++ portions
MyPy			The compiled version of MyPy using MyPyC.
Prophet			Tool for producing high quality forecasts for time series data that has multiple seasonality with linear or non-linear growth.
Kivy			Open source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS

ℹ️ That's just a handful, there are many more! Check out the Working Examples page in the docs.

Legal note

Since cibuildwheel repairs the wheel with delocate or auditwheel, it might automatically bundle dynamically linked libraries from the build machine.

It helps ensure that the library can run without any dependencies outside of the pip toolchain.

This is similar to static linking, so it might have some license implications. Check the license for any code you're pulling in to make sure that's allowed.

Changelog

v3.1.3

1 August 2025

• 🐛 Fix bug where "latest" dependencies couldn't update to pip 25.2 on Windows (#2537)
• 🛠 Use pytest-rerunfailures to improve some of our iOS/Android tests (#2527, #2539)
• 🛠 Remove some GraalPy Windows workarounds in our tests (#2501)

v3.1.2

29 July 2025

• ⚠️ Add an error if CIBW_FREE_THREADING_SUPPORT is set; you are likely missing 3.13t wheels, please use the enable/CIBW_ENABLE (#2520)
• 🛠 riscv64 now enabled if you target that architecture, it's now supported on PyPI (#2509)
• 🛠 Add warning when using cpython-experimental-riscv64 (no longer needed) (#2526, #2528)
• 🛠 iOS versions bumped, fixing issues with 3.14 (now RC 1) (#2530)
• 🐛 Fix bug in Android running wheel from our GitHub Action (#2517)
• 🐛 Fix warning when using test-skip of "*-macosx_universal2:arm64" (#2522)
• 🐛 Fix incorrect number of wheels reported in logs, again (#2517)
• 📚 We welcome our Android platform maintainer (#2516)

v3.1.1

24 July 2025

• 🐛 Fix a bug showing an incorrect wheel count at the end of execution, and misrepresenting test-only runs in the GitHub Action summary (#2512)
• 📚 Docs fix (#2510)

v3.1.0

23 July 2025

• 🌟 CPython 3.14 wheels are now built by default - without the "cpython-prerelease" enable set. It's time to build and upload these wheels to PyPI! This release includes CPython 3.14.0rc1, which is guaranteed to be ABI compatible with the final release. (#2507) Free-threading is no longer experimental in 3.14, so you have to skip it explicitly with 'cp31?t-*' if you don't support it yet. (#2503)
• 🌟 Adds the ability to build wheels for Android! Set the platform option to android on Linux or macOS to try it out! (#2349)
• 🌟 Adds Pyodide 0.28, which builds 3.13 wheels (#2487)
• ✨ Support for 32-bit manylinux_2_28 (now a consistent default) and manylinux_2_34 added (#2500)
• 🛠 Improved summary, will also use markdown summary output on GHA (#2469)
• 🛠 The riscv64 images now have a working default (as they are now part of pypy/manylinux), but are still experimental (and behind an enable) since you can't push them to PyPI yet (#2506)
• 🛠 Fixed a typo in the 3.9 MUSL riscv64 identifier (cp39-musllinux_ricv64 -> cp39-musllinux_riscv64) (#2490)
• 🛠 Mistyping --only now shows the correct possibilities, and even suggests near matches on Python 3.14+ (#2499)
• 🛠 Only support one output from the repair step on linux like other platforms; auditwheel fixed this over four years ago! (#2478)
• 🛠 We now use pattern matching extensively (#2434)
• 📚 We now have platform maintainers for our special platforms and interpreters! (#2481)

v3.0.1

5 July 2025

• 🛠 Updates CPython 3.14 prerelease to 3.14.0b3 (#2471)
• ✨ Adds a CPython 3.14 prerelease iOS build (only when prerelease builds are enabled) (#2475)

---

That's the last few versions.

ℹ️ Want more changelog? Head over to the changelog page in the docs.

---

Contributing

For more info on how to contribute to cibuildwheel, see the docs.

Everyone interacting with the cibuildwheel project via codebase, issue tracker, chat rooms, or otherwise is expected to follow the PSF Code of Conduct.

Maintainers

Core:

• Joe Rickerby @joerick
• Yannick Jadoul @YannickJadoul
• Matthieu Darbois @mayeut
• Henry Schreiner @henryiii
• Grzegorz Bokota @Czaki

Platform maintainers:

• Russell Keith-Magee @freakboy3742 (iOS)
• Agriya Khetarpal @agriyakhetarpal (Pyodide)
• Hood Chatham @hoodmane (Pyodide)
• Gyeongjae Choi @ryanking13 (Pyodide)
• Tim Felgentreff @timfel (GraalPy)
• Malcolm Smith @mhsmith (Android)

Credits

cibuildwheel stands on the shoulders of giants.

• ⭐️ @matthew-brett for multibuild and matthew-brett/delocate
• @PyPA for the manylinux Docker images pypa/manylinux
• @ogrisel for wheelhouse-uploader and run_with_env.cmd

Massive props also to-

• @zfrenchee for help debugging many issues
• @lelit for some great bug reports and contributions
• @mayeut for a phenomenal PR patching Python itself for better compatibility!
• @czaki for being a super-contributor over many PRs and helping out with countless issues!
• @mattip for his help with adding PyPy support to cibuildwheel

See also

Another very similar tool to consider is matthew-brett/multibuild. multibuild is a shell script toolbox for building a wheel on various platforms. It is used as a basis to build some of the big data science tools, like SciPy.

If you are building Rust wheels, you can get by without some of the tricks required to make GLIBC work via manylinux; this is especially relevant for cross-compiling, which is easy with Rust. See maturin-action for a tool that is optimized for building Rust wheels and cross-compiling.