-
Notifications
You must be signed in to change notification settings - Fork 322
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.
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
cargo install rerun-cli
#2183
Merged
Merged
cargo install rerun-cli
#2183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes #1997 Most of our users only use the `rerun` library as a logging library but are still paying the cost of compiling the native viewer. With this PR, the `rerun` crate will not have the `native_viewer` (not `web_viewer`) feature on by default. This halves the compilation time on my computer. The `native_viewer` feature is only for users using the `show` or `spawn` features, which will hopefully be removed soon anyay: * #2109 To install the `rerun` binary with `native_viewer` and `web_viewer`, you now have to run `cargo install rerun --features binary`. This will be improved by: * #2108 To make things nicer for us developers, I've added `cargo rerun` as a shorthand for compiling and running `rerun` with the `native_viewer` feature, but NOT the `web_viewer` feature.
Users will now install the `rerun` binary with `cargo install rerun-cli`
emilk
added
🧑💻 dev experience
developer experience (excluding CI)
dependencies
concerning crates, pip packages etc
⏱ build-times
compilation times
labels
May 22, 2023
1 task
Wumpf
approved these changes
May 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like how this promotes a much faster way of working with rerun from rust (no native & webviewer, connect to installed)
it highlights though that we don't have an example illustrating that workflow though 🤔
checks all out for me, let's do this :)
Co-authored-by: Andreas Reich <andreas@rerun.io>
1 task
emilk
added a commit
that referenced
this pull request
May 25, 2023
* Remove `native_viewer` from the default features of `rerun` crate Closes #1997 Most of our users only use the `rerun` library as a logging library but are still paying the cost of compiling the native viewer. With this PR, the `rerun` crate will not have the `native_viewer` (not `web_viewer`) feature on by default. This halves the compilation time on my computer. The `native_viewer` feature is only for users using the `show` or `spawn` features, which will hopefully be removed soon anyay: * #2109 To install the `rerun` binary with `native_viewer` and `web_viewer`, you now have to run `cargo install rerun --features binary`. This will be improved by: * #2108 To make things nicer for us developers, I've added `cargo rerun` as a shorthand for compiling and running `rerun` with the `native_viewer` feature, but NOT the `web_viewer` feature. * Add rerun-cli Users will now install the `rerun` binary with `cargo install rerun-cli` * Add a README.md * better text about how to run examples Co-authored-by: Andreas Reich <andreas@rerun.io> * Improve docs * Update RELEASES.md * Add checking of the docs to the release process --------- Co-authored-by: Andreas Reich <andreas@rerun.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
⏱ build-times
compilation times
dependencies
concerning crates, pip packages etc
🧑💻 dev experience
developer experience (excluding CI)
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1997
Closes #2177
Sibling PR:
rerun-cli
rerun-docs#63What
cargo install rerun-cli
installs thererun
binary.This follows the pattern of e.g. the
wasm-bindgen-cli
crate which installs thewasm-bindgen
binary, while there is also thewasm-bindgen
library crate.At the same time,
cargo add rerun
adds thererun
library dependency, but WITHOUT thenative_viewer
andweb_viewer
dependencies (the former one adds a lot of compile time). This is a great improvement for most users that are only usingrerun
as a logging library.When developing, the preferred way of running the
rerun
binary is now withcargo rerun
.Future work
We could move the whole
run.rs
part ofrerun
torerun-cli
and havererun_py
depend on the latter instead of the former. This would allow us to remove even more dependencies fromrerun
, improving its compile-time furtherChecklist
PR Build Summary: https://build.rerun.io/pr/2183