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.

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

API to load and send .rbl file from code #6103

Closed
jleibs opened this issue Apr 24, 2024 · 3 comments
Closed

API to load and send .rbl file from code #6103

jleibs opened this issue Apr 24, 2024 · 3 comments
Labels
🟦 blueprint The data that defines our UI 🪵 Log & send APIs Affects the user-facing API for all languages

Comments

@jleibs
Copy link
Member

jleibs commented Apr 24, 2024

To work around situations where blueprint APIs don't yet cover features, users can still manually edit blueprint in the viewer and save them. Unfortunately these blueprints still need to be distributed and manually loaded.

We should add a logging API that opens and existing .rbl file, and sends it to the viewer.

for example:

blueprint = rrb.Blueprint.from_file("my_blueprint.rbl")
rr.send_blueprint(blueprint)
@jleibs jleibs added 🟦 blueprint The data that defines our UI 🪵 Log & send APIs Affects the user-facing API for all languages labels Apr 24, 2024
@jleibs
Copy link
Member Author

jleibs commented Sep 9, 2024

This actually works using the log_file API call, but could use some more documentation and an example.

@Famok
Copy link

Famok commented Nov 3, 2024

@jleibs i was looking for this feature. You first proposed a new logging API which I'd very much like to have.
Then you said this already works using log_file. Can you tell me how?

EDIT: Omg, this is way easier than I thought: docs
rr.log_file_from_path(<path_to_rbl>)

@teh-cmc
Copy link
Member

teh-cmc commented Nov 5, 2024

There's actually a guide for this now:

It won't show up on the website until we publish the 0.20 docs though.

@teh-cmc teh-cmc closed this as completed Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🟦 blueprint The data that defines our UI 🪵 Log & send APIs Affects the user-facing API for all languages
Projects
None yet
Development

No branches or pull requests

3 participants