Make clear local builds are optional

This commit is contained in:
Joe Rickerby
2021-08-28 12:24:21 +01:00
parent 8bd05daf2c
commit 326a9a942b
+13 -6
View File
@@ -2,16 +2,18 @@
title: 'Setup' title: 'Setup'
--- ---
# Run cibuildwheel locally {: #local} # Run cibuildwheel locally (optional) {: #local}
If you've got [Docker](https://www.docker.com/products/docker-desktop) Before getting to CI setup, it can be convenient to test cibuildwheel
installed on your development machine, you can run a Linux build without even locally to quickly iterate and track down issues. If you've got
[Docker](https://www.docker.com/products/docker-desktop) installed on
your development machine, you can run a Linux build without even
touching CI. touching CI.
!!! tip !!! tip
Even Windows can run Linux containers these days, but there are a few You can run the Linux build on any platform. Even Windows can run
hoops to jump through. Check [this Linux containers these days, but there are a few hoops to jump
document](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/quick-start-windows-10-linux) through. Check [this document](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/quick-start-windows-10-linux)
for more info. for more info.
This is convenient as it's quicker to iterate, and because the builds are This is convenient as it's quicker to iterate, and because the builds are
@@ -24,6 +26,11 @@ pip install cibuildwheel
cibuildwheel --platform linux cibuildwheel --platform linux
``` ```
Or, using [pipx](https://github.com/pypa/pipx):
```sh
pipx run cibuildwheel --platform linux
```
You should see the builds taking place. You can experiment with options using environment variables or pyproject.toml. You should see the builds taking place. You can experiment with options using environment variables or pyproject.toml.
!!! tab "Environment variables" !!! tab "Environment variables"