Skip to content

Commit

Permalink
Update wheel build instruction (#8235)
Browse files Browse the repository at this point in the history
Co-authored-by: Julian Viereck <julian.viereck@gmail.com>
Co-authored-by: Andreas Reich <andreas@rerun.io>
  • Loading branch information
3 people authored Nov 28, 2024
1 parent a54c2c5 commit 8245d0a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 5 additions & 3 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,17 @@ pixi run py-fmt
```

### Building an installable Python wheel
The `py-wheel` command builds a whl file:
The `py-build-wheels-sdk-only` command builds a whl file:
```sh
pixi run py-wheel --release
pixi run py-build-wheels-sdk-only
```
Which you can then install in your own Python environment:
```sh
pip install ./target/wheels/*.whl
pip install ./dist/CURRENT_ARCHITECTURE/*.whl
```

**IMPORTANT**: unlike the official wheels, wheels produced by this method do _not_ contain the viewer, so they may only be used for logging purposes.

## Building and installing the Rerun C++ SDK

On Windows you have to have a system install of Visual Studio 2022 in order to compile the SDK and samples.
Expand Down
4 changes: 4 additions & 0 deletions pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,10 @@ py-build-notebook = { cmd = "pip install -e rerun_notebook", depends_on = [
"js-build-base",
] }

# Build an installable SDK-only wheel. IMPORTANT: unlike the officially published wheels, the wheel produced by this command does NOT include the viewer.
# TODO(ab): add a command that produce a complete wheel, including the viewer.
py-build-wheels-sdk-only = { cmd = "RERUN_ALLOW_MISSING_BIN=1 python scripts/ci/build_and_upload_wheels.py --mode pr --dir ''" }


[feature.python-tasks.tasks]

Expand Down

0 comments on commit 8245d0a

Please sign in to comment.