Build Python wheels on CI with minimal configuration.
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.
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 |
|
---|---|---|---|---|---|---|---|---|---|---|
CPython 3.6 | ✅ | N/A | ✅ | ✅ | N/A | ✅ | ✅ | ✅ | ✅ | ✅ |
CPython 3.7 | ✅ | N/A | ✅ | ✅ | N/A | ✅ | ✅ | ✅ | ✅ | ✅ |
CPython 3.8 | ✅ | ✅ | ✅ | ✅ | N/A | ✅ | ✅ | ✅ | ✅ | ✅ |
CPython 3.9 | ✅ | ✅ | ✅ | ✅ | ✅² | ✅³ | ✅ | ✅ | ✅ | ✅ |
CPython 3.10 | ✅ | ✅ | ✅ | ✅ | ✅² | ✅ | ✅ | ✅ | ✅ | ✅ |
CPython 3.11 | ✅ | ✅ | ✅ | ✅ | ✅² | ✅ | ✅ | ✅ | ✅ | ✅ |
CPython 3.12⁵ | ✅ | ✅ | ✅ | ✅ | ✅² | ✅ | ✅ | ✅ | ✅ | ✅ |
PyPy 3.7 v7.3 | ✅ | N/A | ✅ | N/A | N/A | ✅¹ | ✅¹ | ✅¹ | N/A | N/A |
PyPy 3.8 v7.3 | ✅ | ✅⁴ | ✅ | N/A | N/A | ✅¹ | ✅¹ | ✅¹ | N/A | N/A |
PyPy 3.9 v7.3 | ✅ | ✅⁴ | ✅ | N/A | N/A | ✅¹ | ✅¹ | ✅¹ | N/A | N/A |
PyPy 3.10 v7.3 | ✅ | ✅⁴ | ✅ | N/A | N/A | ✅¹ | ✅¹ | ✅¹ | N/A | N/A |
¹ PyPy is only supported for manylinux wheels.
² Windows arm64 support is experimental.
³ Alpine 3.14 and very briefly 3.15's default python3 was not able to load musllinux wheels. This has been fixed; please upgrade the python package if using Alpine from before the fix.
⁴ Cross-compilation not supported with PyPy - to build these wheels you need to run cibuildwheel on an Apple Silicon machine.
⁵ CPython 3.12 is built by default using Python RCs, starting with cibuildwheel 2.15.
See the cibuildwheel 1 documentation if you need to build unsupported versions of Python, such as Python 2.
cibuildwheel
runs inside a CI service. Supported platforms depend on which service you're using:
Linux | macOS | Windows | Linux ARM | macOS ARM | Windows ARM | |
---|---|---|---|---|---|---|
GitHub Actions | ✅ | ✅ | ✅ | ✅¹ | ✅² | ✅⁴ |
Azure Pipelines | ✅ | ✅ | ✅ | ✅² | ✅⁴ | |
Travis CI | ✅ | ✅ | ✅ | |||
AppVeyor | ✅ | ✅ | ✅ | ✅² | ✅⁴ | |
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
and the arm64
part of a universal2
wheel on this CI platform.
³ Uses cross-compilation. Thanks to Rosetta 2 emulation, it is possible to test x86_64
and both parts of a universal2
wheel on this CI platform.
⁴ Uses cross-compilation. It is not possible to test arm64
on this CI platform.
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-20.04, windows-2019, macOS-11]
steps:
- uses: actions/checkout@v4
# Used to host cibuildwheel
- uses: actions/setup-python@v3
- name: Install cibuildwheel
run: python -m pip install cibuildwheel==2.16.2
- 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@v3
with:
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.
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 | CIBW_PLATFORM |
Override the auto-detected target platform |
CIBW_BUILD CIBW_SKIP |
Choose the Python versions to build | |
CIBW_ARCHS |
Change the architectures built on your machine by default. | |
CIBW_PROJECT_REQUIRES_PYTHON |
Manually set the Python compatibility of your project | |
CIBW_PRERELEASE_PYTHONS |
Enable building with pre-release versions of Python if available | |
Build customization | CIBW_BUILD_FRONTEND |
Set the tool to use to build, either "pip" (default for now) or "build" |
CIBW_ENVIRONMENT |
Set environment variables needed during the build | |
CIBW_ENVIRONMENT_PASS_LINUX |
Set environment variables on the host to pass-through to the container during the build. | |
CIBW_BEFORE_ALL |
Execute a shell command on the build system before any wheels are built. | |
CIBW_BEFORE_BUILD |
Execute a shell command preparing each wheel's build | |
CIBW_REPAIR_WHEEL_COMMAND |
Execute a shell command to repair each built wheel | |
CIBW_MANYLINUX_*_IMAGE CIBW_MUSLLINUX_*_IMAGE |
Specify alternative manylinux / musllinux Docker images | |
CIBW_CONTAINER_ENGINE |
Specify which container engine to use when building Linux wheels | |
CIBW_DEPENDENCY_VERSIONS |
Specify how cibuildwheel controls the versions of the tools it uses | |
Testing | CIBW_TEST_COMMAND |
Execute a shell command to test each built wheel |
CIBW_BEFORE_TEST |
Execute a shell command before testing each wheel | |
CIBW_TEST_REQUIRES |
Install Python dependencies before running the tests | |
CIBW_TEST_EXTRAS |
Install your wheel for testing using extras_require | |
CIBW_TEST_SKIP |
Skip running tests on some builds | |
Other | CIBW_BUILD_VERBOSITY |
Increase/decrease the output of pip wheel |
These options can be specified in a pyproject.toml file, as well; see configuration.
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. | ||
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. | ||
Matplotlib | The venerable Matplotlib, a Python library with C++ portions | ||
NCNN | ncnn is a high-performance neural network inference framework optimized for the mobile platform | ||
Prophet | Tool for producing high quality forecasts for time series data that has multiple seasonality with linear or non-linear growth. | ||
MyPy | The compiled version of MyPy using MyPyC. | ||
Kivy | Open source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS | ||
duckdb | DuckDB is an in-process SQL OLAP Database Management System |
ℹ️ That's just a handful, there are many more! Check out the Working Examples page in the docs.
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.
3 October 2023
CIBW_DEBUG_KEEP_CONTAINER
to stop cibuildwheel deleting build containers after the build finishes. (#1620)[tool.cibuildwheel]
checking by adding a schema compatible with the validate-pyproject tool (#1622, #1628, #1629)CIBW_CONTAINER_ENGINE
and CIBW_BUILD_FRONTEND
options to not break arguments on :
characters (#1621)CIBW_ENVIRONMENT
and CIBW_ENVIRONMENT_PASS
so that CIBW_ENVIRONMENT
assignments can reference environment variables passed through from the host machine. (#1617)manylinux-interpreters
tool (#1630)26 September 2023
linux32
in containers when necessary (#1599)18 September 2023
requires_python
auto-detection from setup.py when the call to setup()
is within an if __name__ == "__main__"
block (#1613)--only
can now select prerelease-pythons (#1564)8 August 2023
15 July 2023
That's the last few versions.
ℹ️ Want more changelog? Head over to the changelog page in the docs.
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.
cibuildwheel
stands on the shoulders of giants.
run_with_env.cmd
Massive props also to-
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.