Build Python wheels on CI with minimal configuration.

These details have not been verified by PyPI

Project links

Project description

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?

	macOS Intel	macOS Apple Silicon	Windows 64bit	Windows 32bit	manylinux musllinux x86_64	manylinux musllinux i686	manylinux musllinux aarch64	manylinux musllinux ppc64le	manylinux musllinux s390x
CPython 3.6	✅	N/A	✅	✅	✅	✅	✅	✅	✅
CPython 3.7	✅	N/A	✅	✅	✅	✅	✅	✅	✅
CPython 3.8	✅	✅	✅	✅	✅	✅	✅	✅	✅
CPython 3.9	✅	✅	✅	✅	✅	✅	✅	✅	✅
CPython 3.10	✅	✅	✅	✅	✅	✅	✅	✅	✅
PyPy 3.7 v7.3	✅	N/A	✅	N/A	✅¹	✅¹	✅¹	N/A	N/A

^{¹ PyPy is only supported for manylinux wheels.}

Builds manylinux, musllinux, macOS 10.9+, and Windows wheels for CPython and PyPy
Works on GitHub Actions, Azure Pipelines, Travis CI, AppVeyor, CircleCI, and GitLab 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
GitHub Actions	✅	✅	✅	✅¹
Azure Pipelines	✅	✅	✅
Travis CI	✅		✅	✅
AppVeyor	✅	✅	✅
CircleCI	✅	✅
Gitlab 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.}

cibuildwheel is not intended to run on your development machine. Because it uses system Python from Python.org on macOS and Windows, it will try to install packages globally - not what you expect from a build tool! Instead, isolated CI services like those mentioned above are ideal. For Linux builds, it uses manylinux docker images, so those can be done locally for testing in a pinch.

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-20.04, windows-2019, macOS-10.15]

    steps:
      - uses: actions/checkout@v2

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

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

      - 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@v2
        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.

Options

	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_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 (non-pure Python) built wheel
	`CIBW_MANYLINUX__IMAGE` `CIBW_MUSLLINUX__IMAGE`	Specify alternative manylinux / musllinux Docker images
	`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.

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.
Tornado			Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed.
Matplotlib			The venerable Matplotlib, a Python library with C++ portions
pytorch-fairseq			Facebook AI Research Sequence-to-Sequence Toolkit written in Python.
MyPy			MyPyC, the compiled component of MyPy.
uvloop			Ultra fast asyncio event loop.
pydantic			Data parsing and validation using Python type hints
psutil			Cross-platform lib for process and system monitoring in Python
vaex			Out-of-Core hybrid Apache Arrow/NumPy DataFrame for Python, ML, visualize and explore big tabular data at a billion rows per second 🚀
Google Benchmark			A microbenchmark support library

ℹ️ 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 licence implications. Check the license for any code you're pulling in to make sure that's allowed.

Changelog

v2.2.1

26 October 2021

🛠 Added a config-file option on the GitHub Action to specify something other than pyproject.toml in your GitHub Workflow file. (#883)
🐛 Fix missing resources in sdist and released wheel on PyPI. We've also made some internal changes to our release processes to make them more reliable. (#893, #894)

v2.2.0

22 October 2021

🌟 Added support for musllinux. Support for this new wheel format lets projects build wheels for Linux distributions that use musl libc, notably, Alpine Docker containers. (#768)

Musllinux builds are enabled by default. If you're not ready to build musllinux, add *-musllinux_* to your CIBW_SKIP/skip option. Or, you might have to make some changes to your options - to simplify that process, you can use...
🌟 TOML option overrides! This provides much greater flexibility in configuration via pyproject.toml. (#854)

You can now set build options for any subset of your builds using a match pattern. So, for example, you can customise CPython 3.8 builds with an override on cp38-* or musllinux builds by selecting *musllinux*. Check out the docs for more info on the specifics.
🛠 Added support for building PyPy wheels on macOS 11 CI runners. (#875)
🛠 Setting an empty string for the CIBW_*_IMAGE option will now fallthrough to the config file or cibuildwheel's default, rather than causing an error. This makes the option easier to use in CI build matricies. (#829)
🛠 Support for TOML 1.0 when reading config files, via the tomli package. (#876)

^{Note: This version is not available on PyPI due to some missing resources in the release files. Please use v2.2.1 instead.}

v2.1.3

6 October 2021

🛠 Updated CPython 3.10 to the 3.10.0 final release

v2.1.2

14 September 2021

🛠 Updated CPython 3.10 to 3.10.0rc2
📚 Multiple docs updates
🐛 Improved warnings when built binaries are bundled into the container on Linux. (#807)

v2.1.1

7 August 2021

✨ Corresponding with the release of CPython 3.10.0rc1, which is ABI stable, cibuildwheel now builds CPython 3.10 by default - without the CIBW_PRERELEASE_PYTHONS flag.

^{Note: v2.1.0 was a bad release, it was yanked from PyPI.}

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

Joe Rickerby @joerick
Yannick Jadoul @YannickJadoul
Matthieu Darbois @mayeut
Henry Schreiner @henryiii

Credits

cibuildwheel stands on the shoulders of giants.

⭐️ @matthew-brett for matthew-brett/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

Algorithm	Hash digest
SHA256	`b740995c93b8fbcc499bcdf30805e439a7e83f038ddc3b89be78d2c03ac2a9c4`
MD5	`f086abd83fc442a679691beec8f69393`
BLAKE2b-256	`0665ad9eaefe2cb37d9850f0afb235026febce2e0d89ea7d56d9645bb5e209d6`

Algorithm	Hash digest
SHA256	`c6e774265e08cf595bc36d16ac8ea4ab9a70a176e748f4f8a444a3b25ef97645`
MD5	`b30aa591867ca50333cdf6e23e35c973`
BLAKE2b-256	`a7c1eab73fb628177d65383ee23dc3cc0020fa28fe0072c17896298121df97f9`

cibuildwheel 2.2.1

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

cibuildwheel

What does it do?

Usage

Example setup

Options

Working examples

Legal note

Changelog

v2.2.1

v2.2.0

v2.1.3

v2.1.2

v2.1.1

Contributing

Maintainers

Credits

See also

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes