Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/pyproject/_shared/latest--partial-cibuildwheel.json
Parent schema pyproject
Type: object

cibuildwheel's settings. Generated with ./bin/generate_schema.py --schemastore from cibuildwheel.

Properties

archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build string | string[]

Choose the Python versions to build.

Default:
[
  "*"
]
build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

container-engine enum | string | string | object
dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
enable enable | enable[]

Enable or disable certain builds.

environment string | object

Set environment variables needed during the build.

environment-pass string | string[]

Set environment variables on the host to pass-through to the container during the build.

manylinux-aarch64-image string

Specify alternative manylinux / musllinux container images

manylinux-armv7l-image string

Specify alternative manylinux / musllinux container images

manylinux-i686-image string

Specify alternative manylinux / musllinux container images

manylinux-ppc64le-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_aarch64-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_i686-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_x86_64-image string

Specify alternative manylinux / musllinux container images

manylinux-riscv64-image string

Specify alternative manylinux / musllinux container images

manylinux-s390x-image string

Specify alternative manylinux / musllinux container images

manylinux-x86_64-image string

Specify alternative manylinux / musllinux container images

musllinux-aarch64-image string

Specify alternative manylinux / musllinux container images

musllinux-armv7l-image string

Specify alternative manylinux / musllinux container images

musllinux-i686-image string

Specify alternative manylinux / musllinux container images

musllinux-ppc64le-image string

Specify alternative manylinux / musllinux container images

musllinux-riscv64-image string

Specify alternative manylinux / musllinux container images

musllinux-s390x-image string

Specify alternative manylinux / musllinux container images

musllinux-x86_64-image string

Specify alternative manylinux / musllinux container images

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

skip string | string[]

Choose the Python versions to skip.

test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-skip string | string[]

Skip running tests on some builds.

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

overrides object[]

An overrides array

linux object
37 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

container-engine enum | string | string | object
environment string | object

Set environment variables needed during the build.

environment-pass string | string[]

Set environment variables on the host to pass-through to the container during the build.

manylinux-aarch64-image string

Specify alternative manylinux / musllinux container images

manylinux-armv7l-image string

Specify alternative manylinux / musllinux container images

manylinux-i686-image string

Specify alternative manylinux / musllinux container images

manylinux-ppc64le-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_aarch64-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_i686-image string

Specify alternative manylinux / musllinux container images

manylinux-pypy_x86_64-image string

Specify alternative manylinux / musllinux container images

manylinux-riscv64-image string

Specify alternative manylinux / musllinux container images

manylinux-s390x-image string

Specify alternative manylinux / musllinux container images

manylinux-x86_64-image string

Specify alternative manylinux / musllinux container images

musllinux-aarch64-image string

Specify alternative manylinux / musllinux container images

musllinux-armv7l-image string

Specify alternative manylinux / musllinux container images

musllinux-i686-image string

Specify alternative manylinux / musllinux container images

musllinux-ppc64le-image string

Specify alternative manylinux / musllinux container images

musllinux-riscv64-image string

Specify alternative manylinux / musllinux container images

musllinux-s390x-image string

Specify alternative manylinux / musllinux container images

musllinux-x86_64-image string

Specify alternative manylinux / musllinux container images

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

Default: "auditwheel repair -w {dest_dir} {wheel}"
test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

windows object
19 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
environment string | object

Set environment variables needed during the build.

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

macos object
19 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
environment string | object

Set environment variables needed during the build.

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

Default: "delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}"
test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

pyodide object
19 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
environment string | object

Set environment variables needed during the build.

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

android object
19 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
environment string | object

Set environment variables needed during the build.

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

ios object
19 nested properties
archs string | string[]

Change the architectures built on your machine by default.

before-all string | string[]

Execute a shell command on the build system before any wheels are built.

before-build string | string[]

Execute a shell command preparing each wheel's build.

before-test string | string[]

Execute a shell command before testing each wheel.

build-frontend enum | string | string | string | string | object

Set the tool to use to build, either "build" (default), "build[uv]", "uv", or "pip"

Default: "default"
build-verbosity integer

Increase/decrease the output of pip wheel.

Default: 0
min=-3max=3
config-settings string | object

Specify config-settings for the build backend.

dependency-versions enum | string | object | object

Specify how cibuildwheel controls the versions of the tools it uses

Default: "pinned"
environment string | object

Set environment variables needed during the build.

xbuild-tools string | string[]

Binaries on the path that should be included in an isolated cross-build environment

pyodide-version string

Specify the version of Pyodide to use

repair-wheel-command string | string[]

Execute a shell command to repair each built wheel.

test-command string | string[]

Execute a shell command to test each built wheel.

test-extras string | string[]

Install your wheel for testing using extras_require

test-sources string | string[]

Test files that are required by the test environment

test-groups string | string[]

Install extra groups when testing

test-requires string | string[]

Install Python dependencies before running the tests

test-environment string | object

Set environment variables for the test environment

test-runtime string | object | string | object

Additional configuration for the test runner

Definitions

inherit enum

How to inherit the parent's value.

enable enum