Hongru/cibuildwheel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add multiline examples

Browse Source
This commit is contained in:
Henry Schreiner
2021-07-15 22:30:35 -04:00
parent 25c27ad283
commit d31df17f3a
1 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/options.md
+32 -5
View File
@@ -738,6 +738,11 @@ Platform-specific environment variables are also available:<br/>
# Pass the `--lib-sdir .` flag to auditwheel on Linux # Pass the `--lib-sdir .` flag to auditwheel on Linux
CIBW_REPAIR_WHEEL_COMMAND_LINUX: "auditwheel repair --lib-sdir . -w {dest_dir} {wheel}" CIBW_REPAIR_WHEEL_COMMAND_LINUX: "auditwheel repair --lib-sdir . -w {dest_dir} {wheel}"
# Multi-line example - use && to join on all platforms
CIBW_REPAIR_WHEEL_COMMAND: >
python scripts/repair_wheel.py -w {dest_dir} {wheel} &&
python scripts/check_repaired_wheel.py -w {dest_dir} {wheel}
``` ```
!!! tab examples "pyproject.toml" !!! tab examples "pyproject.toml"
@@ -745,16 +750,23 @@ Platform-specific environment variables are also available:<br/>
```toml ```toml
# Use delvewheel on windows # Use delvewheel on windows
[tool.cibuildwheel.windows] [tool.cibuildwheel.windows]
before_build = "pip install delvewheel" before-build = "pip install delvewheel"
repair_wheel_command = "delvewheel repair -w {dest_dir} {wheel}" repair-wheel-command = "delvewheel repair -w {dest_dir} {wheel}"
# Don't repair macOS wheels # Don't repair macOS wheels
[tool.cibuildwheel.macos] [tool.cibuildwheel.macos]
repair_wheel_command = "" repair-wheel-command = ""
# Pass the `--lib-sdir .` flag to auditwheel on Linux # Pass the `--lib-sdir .` flag to auditwheel on Linux
[tool.cibuildwheel.linux] [tool.cibuildwheel.linux]
repair_wheel_command = "auditwheel repair --lib-sdir . -w {dest_dir} {wheel}" repair-wheel-command = "auditwheel repair --lib-sdir . -w {dest_dir} {wheel}"
# Multi-line example
[tool.cibuildwheel]
repair-wheel-command = [
'python scripts/repair_wheel.py -w {dest_dir} {wheel}',
'python scripts/check_repaired_wheel.py -w {dest_dir} {wheel}',
]
``` ```
In configuration mode, you can use an inline array, and the items will be joined with `&&`. In configuration mode, you can use an inline array, and the items will be joined with `&&`.
@@ -943,6 +955,11 @@ Platform-specific environment variables are also available:<br/>
# Trigger an install of the package, but run nothing of note # Trigger an install of the package, but run nothing of note
CIBW_TEST_COMMAND: "echo Wheel installed" CIBW_TEST_COMMAND: "echo Wheel installed"
# Multi-line example - join with && on all platforms
CIBW_TEST_COMMAND: >
pytest {package}/tests &&
python {package}/test.py
``` ```
!!! tab examples "pyproject.toml" !!! tab examples "pyproject.toml"
@@ -957,6 +974,12 @@ Platform-specific environment variables are also available:<br/>
# Trigger an install of the package, but run nothing of note # Trigger an install of the package, but run nothing of note
test-command = "echo Wheel installed" test-command = "echo Wheel installed"
# Multiline example
test-command = [
"pytest {package}/tests",
"python {package}/test.py",
]
``` ```
In configuration files, you can use an array, and the items will be joined with `&&`. In configuration files, you can use an array, and the items will be joined with `&&`.
@@ -987,7 +1010,11 @@ Platform-specific environment variables are also available:<br/>
CIBW_BEFORE_TEST: rm -rf ./data/cache && mkdir -p ./data/cache CIBW_BEFORE_TEST: rm -rf ./data/cache && mkdir -p ./data/cache
# Install non pip python package # Install non pip python package
CIBW_BEFORE_TEST: cd some_dir; ./configure; make; make install CIBW_BEFORE_TEST: >
cd some_dir &&
./configure &&
make &&
make install
# Install python packages that are required to install test dependencies # Install python packages that are required to install test dependencies
CIBW_BEFORE_TEST: pip install cmake scikit-build CIBW_BEFORE_TEST: pip install cmake scikit-build