cibuildwheel¶

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, AppVeyor, CircleCI, and GitLab CI - and it builds and tests your wheels across all of your platforms.

What does it do?¶

^{¹ PyPy is only supported for manylinux wheels.
² Windows arm64 support is experimental.}

• Builds manylinux, musllinux, macOS 10.9+, and Windows wheels for CPython and PyPy
• Works on GitHub Actions, Azure Pipelines, Travis CI, AppVeyor, 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:

^{¹ 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.}

To get started, head over to the setup guide.

How it works¶

This diagram summarises the steps that cibuildwheel takes on each platform to build your package's wheels.

This isn't exhaustive, for a full list of the things cibuildwheel can do, check the options page.