Skip to content

Commit 5d2c47e

Browse files
reformat
1 parent a5decf4 commit 5d2c47e

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

scripts/wheelbuilder/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Scripts to build wheels for GraalPy.
22

3-
[GraalPy](https://github.com/oracle/graalpython) is compatible with many Python libraries, including those that extend the Python runtime with native code.
4-
However, implemented in Java and thus binary incompatible with existing extensions, users of native Python extension libraries such as NumPy, SciPy, or PyTorch have to build their own binaries when installing these libraries if neither the project nor the GraalPy team provides prebuilt wheels.
5-
For many libraries, this means installing additional build dependencies and sitting through long and resource-intensive compilation processes.
3+
[GraalPy](https://github.com/oracle/graalpython) is compatible with many Python libraries, including those that extend
4+
the Python runtime with native code.
5+
However, implemented in Java and thus binary incompatible with existing extensions, users of native Python extension
6+
libraries such as NumPy, SciPy, or PyTorch have to build their own binaries when installing these libraries if neither
7+
the project nor the GraalPy team provides prebuilt wheels.
8+
For many libraries, this means installing additional build dependencies and sitting through long and resource-intensive
9+
compilation processes.
610

7-
This project is meant to be a place for the community to collect build recipes for as many popular packages as possible that can then be built individually or in CI/CD systems like GitHub Actions.
11+
This project is meant to be a place for the community to collect build recipes for as many popular packages as possible
12+
that can then be built individually or in CI/CD systems like GitHub Actions.
813

914
## Quickstart
1015

@@ -28,10 +33,12 @@ We collect simple build scripts per platform and package in the `linux`, `darwin
2833
The format is simply the package name followed by `.sh` for macOS and Linux or `.bat` for Windows.
2934
An additional component can be added in between the name and the extension.
3035
This file is then only run if the process environment contains a variable matching the middle component.
31-
That can be useful to put things like package installations specific to GitHub Actions while keeping the main build script generic for other platforms.
36+
That can be useful to put things like package installations specific to GitHub Actions while keeping the main build
37+
script generic for other platforms.
3238

3339
## How to run this
3440

3541
Just run the `build_wheels.py` script.
3642
It expects a URL to download the GraalPy release from.
37-
You can set the environment variable `PACKAGES_TO_BUILD` to a comma-separated list of package build scripts you want to consider.
43+
You can set the environment variable `PACKAGES_TO_BUILD` to a comma-separated list of package build scripts you want to
44+
consider.

0 commit comments

Comments
 (0)