Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update wheel build instruction #8235

Merged
merged 4 commits into from
Nov 28, 2024
Merged

Update wheel build instruction #8235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc39fea
Update BUILD.md
jviereck Nov 22, 2024
eac5125
Added a `py-build-wheels-sdk-only` pixi command and updated BUILD.md
abey79 Nov 28, 2024
fc354f4
Merge branch 'main' into fork/jviereck/patch-1
abey79 Nov 28, 2024
28d05d0
typo fix
Wumpf Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions BUILD.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading