https://github.com/pypa/cibuildwheel

🎡 Build Python wheels for all the platforms with minimal configuration.
https://github.com/pypa/cibuildwheel
appveyor azure-pipelines build-automation ci circleci github-actions pypi python python-wheels travis-ci wheel
Last synced: 17 days ago
JSON representation
🎡 Build Python wheels for all the platforms with minimal configuration.
Host: GitHub
URL: https://github.com/pypa/cibuildwheel
Owner: pypa
License: other
Created: 2017-03-19T20:59:00.000Z (almost 9 years ago)
Default Branch: main
Last Pushed: 2025-05-11T09:16:55.000Z (9 months ago)
Last Synced: 2025-05-11T11:12:13.556Z (9 months ago)
Topics: appveyor, azure-pipelines, build-automation, ci, circleci, github-actions, pypi, python, python-wheels, travis-ci, wheel
Language: Python
Homepage: https://cibuildwheel.pypa.io
Size: 6.33 MB
Stars: 1,980
Watchers: 24
Forks: 262
Open Issues: 112
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project

README

          cibuildwheel

============

[![PyPI](https://img.shields.io/pypi/v/cibuildwheel.svg)](https://pypi.python.org/pypi/cibuildwheel)

[![Documentation Status](https://readthedocs.org/projects/cibuildwheel/badge/?version=stable)](https://cibuildwheel.pypa.io/en/stable/?badge=stable)

[![Actions Status](https://github.com/pypa/cibuildwheel/workflows/Test/badge.svg)](https://github.com/pypa/cibuildwheel/actions)

[![Travis Status](https://img.shields.io/travis/com/pypa/cibuildwheel/main?logo=travis)](https://travis-ci.com/github/pypa/cibuildwheel)

[![CircleCI Status](https://img.shields.io/circleci/build/gh/pypa/cibuildwheel/main?logo=circleci)](https://circleci.com/gh/pypa/cibuildwheel)

[![Azure Status](https://dev.azure.com/joerick0429/cibuildwheel/_apis/build/status/pypa.cibuildwheel?branchName=main)](https://dev.azure.com/joerick0429/cibuildwheel/_build/latest?definitionId=4&branchName=main)

[Documentation](https://cibuildwheel.pypa.io)

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³      | ✅ | ✅  | ✅  | ✅  | ✅² | ✅ | ✅  | ✅ | ✅  | ✅  | ✅⁵ | ✅  | ✅  | ✅⁴ |

| CPython 3.14       | ✅ | ✅  | ✅  | ✅  | ✅² | ✅ | ✅  | ✅ | ✅  | ✅  | ✅⁵ | ✅  | ✅  | 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 |

| GraalPy 3.12 v25.0 | ✅ | ✅  | ✅  | 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`](https://cibuildwheel.pypa.io/en/stable/options/#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, 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](https://github.com/pypa/auditwheel) and [delocate](https://github.com/matthew-brett/delocate)

- Runs your library's tests against the wheel-installed version of your library

See the [cibuildwheel 1 documentation](https://cibuildwheel.pypa.io/en/1.x/) 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](https://cibuildwheel.pypa.io/en/stable/faq/#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](https://cibuildwheel.pypa.io/en/stable/faq/#windows-arm64). 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](https://cibuildwheel.pypa.io/en/stable/platforms/#android).}


Example setup

-------------

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

```yaml

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-15-intel, macos-latest]

    steps:

      - uses: actions/checkout@v5

      # Used to host cibuildwheel

      - uses: actions/setup-python@v5

      - name: Install cibuildwheel

        run: python -m pip install cibuildwheel==3.3.0

      - 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](https://cibuildwheel.pypa.io) and the [examples](https://github.com/pypa/cibuildwheel/tree/main/examples).

How it works

------------

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

![](docs/data/how-it-works.png)

^{Explore an interactive version of this diagram [in the docs](https://cibuildwheel.pypa.io/en/stable/#how-it-works).}

|   | Option | Description |

|---|---|---|

| **Build selection** | [`platform`](https://cibuildwheel.pypa.io/en/stable/options/#platform) | Override the auto-detected target platform |

|  | [`build`
`skip`](https://cibuildwheel.pypa.io/en/stable/options/#build-skip) | Choose the Python versions to build |

|  | [`archs`](https://cibuildwheel.pypa.io/en/stable/options/#archs) | Change the architectures built on your machine by default. |

|  | [`project-requires-python`](https://cibuildwheel.pypa.io/en/stable/options/#requires-python) | Manually set the Python compatibility of your project |

|  | [`enable`](https://cibuildwheel.pypa.io/en/stable/options/#enable) | Enable building with extra categories of selectors present. |

|  | [`allow-empty`](https://cibuildwheel.pypa.io/en/stable/options/#allow-empty) | Suppress the error code if no wheels match the specified build identifiers |

| **Build customization** | [`build-frontend`](https://cibuildwheel.pypa.io/en/stable/options/#build-frontend) | Set the tool to use to build, either "build" (default), "build\[uv\]", or "pip" |

|  | [`config-settings`](https://cibuildwheel.pypa.io/en/stable/options/#config-settings) | Specify config-settings for the build backend. |

|  | [`environment`](https://cibuildwheel.pypa.io/en/stable/options/#environment) | Set environment variables |

|  | [`environment-pass`](https://cibuildwheel.pypa.io/en/stable/options/#environment-pass) | Set environment variables on the host to pass-through to the container. |

|  | [`before-all`](https://cibuildwheel.pypa.io/en/stable/options/#before-all) | Execute a shell command on the build system before any wheels are built. |

|  | [`before-build`](https://cibuildwheel.pypa.io/en/stable/options/#before-build) | Execute a shell command preparing each wheel's build |

|  | [`xbuild-tools`](https://cibuildwheel.pypa.io/en/stable/options/#xbuild-tools) | Binaries on the path that should be included in an isolated cross-build environment. |

|  | [`repair-wheel-command`](https://cibuildwheel.pypa.io/en/stable/options/#repair-wheel-command) | Execute a shell command to repair each built wheel |

|  | [`manylinux-*-image`
`musllinux-*-image`](https://cibuildwheel.pypa.io/en/stable/options/#linux-image) | Specify manylinux / musllinux container images |

|  | [`container-engine`](https://cibuildwheel.pypa.io/en/stable/options/#container-engine) | Specify the container engine to use when building Linux wheels |

|  | [`dependency-versions`](https://cibuildwheel.pypa.io/en/stable/options/#dependency-versions) | Control the versions of the tools cibuildwheel uses |

|  | [`pyodide-version`](https://cibuildwheel.pypa.io/en/stable/options/#pyodide-version) | Specify the Pyodide version to use for `pyodide` platform builds |

| **Testing** | [`test-command`](https://cibuildwheel.pypa.io/en/stable/options/#test-command) | The command to test each built wheel |

|  | [`before-test`](https://cibuildwheel.pypa.io/en/stable/options/#before-test) | Execute a shell command before testing each wheel |

|  | [`test-sources`](https://cibuildwheel.pypa.io/en/stable/options/#test-sources) | Paths that are copied into the working directory of the tests |

|  | [`test-requires`](https://cibuildwheel.pypa.io/en/stable/options/#test-requires) | Install Python dependencies before running the tests |

|  | [`test-extras`](https://cibuildwheel.pypa.io/en/stable/options/#test-extras) | Install your wheel for testing using `extras_require` |

|  | [`test-groups`](https://cibuildwheel.pypa.io/en/stable/options/#test-groups) | Specify test dependencies from your project's `dependency-groups` |

|  | [`test-skip`](https://cibuildwheel.pypa.io/en/stable/options/#test-skip) | Skip running tests on some builds |

|  | [`test-environment`](https://cibuildwheel.pypa.io/en/stable/options/#test-environment) | Set environment variables for the test environment |

|  | [`test-runtime`](https://cibuildwheel.pypa.io/en/stable/options/#test-runtime) | Controls how the tests will be executed. |

| **Debugging** | [`debug-keep-container`](https://cibuildwheel.pypa.io/en/stable/options/#debug-keep-container) | Keep the container after running for debugging. |

|  | [`debug-traceback`](https://cibuildwheel.pypa.io/en/stable/options/#debug-traceback) | Print full traceback when errors occur. |

|  | [`build-verbosity`](https://cibuildwheel.pypa.io/en/stable/options/#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](https://cibuildwheel.pypa.io/en/latest/configuration/).

Working examples

----------------

Here are some repos that use cibuildwheel.

| Name                              | CI | OS | Notes |

|-----------------------------------|----|----|:------|

| [scikit-learn][]                  | ![github icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | 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.  |

| [duckdb][]                        | ![github icon][] | ![apple icon][] ![linux icon][] ![windows icon][] | DuckDB is an analytical in-process SQL database management system |

| [pytorch-fairseq][]               | ![github icon][] | ![apple icon][] ![linux icon][] | Facebook AI Research Sequence-to-Sequence Toolkit written in Python. |

| [NumPy][]                         | ![github icon][] ![travisci icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | The fundamental package for scientific computing with Python. |

| [NCNN][]                          | ![github icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | ncnn is a high-performance neural network inference framework optimized for the mobile platform |

| [Tornado][]                       | ![github icon][] | ![linux icon][] ![apple icon][] ![windows icon][] | Tornado is a Python web framework and asynchronous networking library. Uses stable ABI for a small C extension. |

| [Matplotlib][]                    | ![github icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | The venerable Matplotlib, a Python library with C++ portions |

| [MyPy][]                          | ![github icon][] | ![apple icon][] ![linux icon][] ![windows icon][] | The compiled version of MyPy using MyPyC. |

| [Prophet][]                       | ![github icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | Tool for producing high quality forecasts for time series data that has multiple seasonality with linear or non-linear growth. |

| [Kivy][]                          | ![github icon][] | ![windows icon][] ![apple icon][] ![linux icon][] | Open source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS |

[scikit-learn]: https://github.com/scikit-learn/scikit-learn

[duckdb]: https://github.com/duckdb/duckdb

[pytorch-fairseq]: https://github.com/facebookresearch/fairseq

[NumPy]: https://github.com/numpy/numpy

[NCNN]: https://github.com/Tencent/ncnn

[Tornado]: https://github.com/tornadoweb/tornado

[Matplotlib]: https://github.com/matplotlib/matplotlib

[MyPy]: https://github.com/mypyc/mypy_mypyc-wheels

[Prophet]: https://github.com/facebook/prophet

[Kivy]: https://github.com/kivy/kivy

[github icon]: docs/data/readme_icons/github.svg

[azurepipelines icon]: docs/data/readme_icons/azurepipelines.svg

[circleci icon]: docs/data/readme_icons/circleci.svg

[gitlab icon]: docs/data/readme_icons/gitlab.svg

[travisci icon]: docs/data/readme_icons/travisci.svg

[cirrusci icon]: docs/data/readme_icons/cirrusci.svg

[windows icon]: docs/data/readme_icons/windows.svg

[apple icon]: docs/data/readme_icons/apple.svg

[linux icon]: docs/data/readme_icons/linux.svg

> ℹ️ That's just a handful, there are many more! Check out the [Working Examples](https://cibuildwheel.pypa.io/en/stable/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.3.0

_12 November 2025_

- 🐛 Fix an incompatibility with Docker v29 (#2660)

- ✨ Adds `test-runtime` option, to customise how tests on simulated/emulated environments are run (#2636)

- ✨ Adds support for new `manylinux_2_35` images on 32-bit ARM `armv7l`, offering better C++20 compatibility (#2656)

- ✨ `build[uv]` is now supported on Android (#2587)

- ✨ You can now install extras (such as `uv`) with a simple option on the GitHub Action (#2630)

- ✨ `{project}` and `{package}` placeholders are now supported in `repair-wheel-command` (#2589)

- 🛠 The versions set with `dependency-versions` no longer constrain packages specified by your `build-system.requires`. Previously, on platforms other than Linux, the constraints in this option would remain in the environment during the build. This has been tidied up make behaviour more consistent between platforms, and to prevent version conflicts. (#2583)

- 🛠 Improve the handling of `test-command` on Android, enabling more options to be passed (#2590)

- 📚 Docs improvements (#2618)

### v3.2.1

_12 October 2025_

- 🛠 Update to CPython 3.14.0 final (#2614)

- 🐛 Fix the default MACOSX_DEPLOYMENT_TARGET on Python 3.14 (#2613)

- 📚 Docs improvements (#2617)

### v3.2.0

_22 September 2025_

- ✨ Adds GraalPy v25 (Python 3.12) support (#2597)

- 🛠 Update to CPython 3.14.0rc3 (#2602)

- 🛠 Adds CPython 3.14.0 prerelease support for Android, and a number of improvements to Android builds (#2568, #2591)

- 🛠 Improvements to testing on Android, passing environment markers when installing the venv, and providing more debug output when build-verbosity is set (#2575)

- ⚠️ PyPy 3.10 was moved to `pypy-eol` in the `enable` option, as it is now end-of-life. (#2521)

- 📚 Docs improvements (#2574, #2601, #2598)

### v3.1.4

_19 August 2025_

- ✨ Add a `--clean-cache` command to clean up our cache (#2489)

- 🛠 Update Python to 3.14rc2 and other patch version bumps (#2542, #2556)

- 🛠 Update Pyodide to 0.28.2 (#2562, #2558)

- 🐛 Fix resolution with `pyodide-build` when `dependency-versions` is set (#2548)

- 🐛 Set `CMAKE_FIND_ROOT_PATH_MODE_PACKAGE` to `BOTH` on Android (#2547)

- 🐛 Add `patchelf` dependency for platforms that can build Android wheels (#2552)

- 🐛 Ignore empty values for `CIBW_ARCHS` like most other environment variables (#2541)

- 💼 The `color` and `suggest_on_error` argparse options are now default in 3.14rc1+ (#2554)

- 💼 Use the virtualenv release URL instead of blob URL (should be more robust) (#2555)

- 🧪 For iOS, lowering to macos-14 is needed for now due to issues with GitHub's runner images (#2557)

- 🧪 Split out platforms iOS and Android in our tests (#2519)

- 🧪 Fix and enable doctests (#2546)

- 📚 Improve our docs on free-threading (#2549)

### 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)

---

That's the last few versions.

ℹ️ **Want more changelog? Head over to [the changelog page in the docs](https://cibuildwheel.pypa.io/en/stable/changelog/).**

---

Contributing

============

For more info on how to contribute to cibuildwheel, see the [docs](https://cibuildwheel.pypa.io/en/latest/contributing/).

Everyone interacting with the cibuildwheel project via codebase, issue tracker, chat rooms, or otherwise is expected to follow the [PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md).

Maintainers

-----------

Core:

- Joe Rickerby [@joerick](https://github.com/joerick)

- Yannick Jadoul [@YannickJadoul](https://github.com/YannickJadoul)

- Matthieu Darbois [@mayeut](https://github.com/mayeut)

- Henry Schreiner [@henryiii](https://github.com/henryiii)

- Grzegorz Bokota [@Czaki](https://github.com/Czaki)

Platform maintainers:

- Russell Keith-Magee [@freakboy3742](https://github.com/freakboy3742) (iOS)

- Agriya Khetarpal [@agriyakhetarpal](https://github.com/agriyakhetarpal) (Pyodide)

- Hood Chatham [@hoodmane](https://github.com/hoodmane) (Pyodide)

- Gyeongjae Choi [@ryanking13](https://github.com/ryanking13) (Pyodide)

- Tim Felgentreff [@timfel](https://github.com/timfel) (GraalPy)

- Malcolm Smith [@mhsmith](https://github.com/mhsmith) (Android)

Credits

-------

`cibuildwheel` stands on the shoulders of giants.

- ⭐️ @matthew-brett for [multibuild](https://github.com/multi-build/multibuild) and [matthew-brett/delocate](http://github.com/matthew-brett/delocate)

- @PyPA for the manylinux Docker images [pypa/manylinux](https://github.com/pypa/manylinux)

- @ogrisel for [wheelhouse-uploader](https://github.com/ogrisel/wheelhouse-uploader) and `run_with_env.cmd`

Massive props also to-

- @zfrenchee for [help debugging many issues](https://github.com/pypa/cibuildwheel/issues/2)

- @lelit for some great bug reports and [contributions](https://github.com/pypa/cibuildwheel/pull/73)

- @mayeut for a [phenomenal PR](https://github.com/pypa/cibuildwheel/pull/71) 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](http://github.com/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](https://github.com/PyO3/maturin-action) for a tool that is optimized for building Rust wheels and cross-compiling.
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pypa/cibuildwheel

Awesome Lists containing this project

README
