Add Wandelbots NOVA bridge as example

[stefanwagnerdev]

Related

• Part of the effort to add more examples

What

Added a comprehensive Nova-Rerun bridge example

[github-actions]

Hi! Thanks for opening this pull request.

Because this is your first time contributing to this repository, make sure you've read our Contributor Guide and Code of Conduct.

[abey79]

Thanks a lot for the contribution. This generally looks great and would be a nice addition to our examples. However, the requirement for a login is not ideal. The way I see it, some version of this example could fall in either or both of these categories:

• A demo of Rerun and how it might integrate with 3rd party services. examples/python/wandelbots_nova is the right place for that, but then it should be runnable with the absolute minimum setup, ideally just a pixi run -e examples wandelbots_nova from a fresh checkout (as are our other examples). In this context, the requirement for a logging is not acceptable.
• A general purpose integration between a third party service and Rerun which aims to be used as is (or with little modifications) by users of said service. For this, we typically use a separate repository (e.g https://github.com/rerun-io/cpp-example-ros2-bridge). In this case, I guess the requirement for a login would be acceptable, given that the intended audience is already using the service.

Is there anyway you could make this example work without login, e.g. by pointing on a public endpoint/dataset, or downloading static data instead of connecting to a live service?

Appart from that, I've already included a bunch of smaller comments/nits in the review, and will do a more thorough pass when we resolve the above.

Finally, to make CI happier, I suggest you install pixi (we're currently on 0.39.0, so please downgrade your install with pixi self-update --version 0.39.0) and check for lints and formatting:

pixi run toml-fmt
pixi run py-lint
pixi run py-fmt

[abey79]

Missing newline at EOF will be rejected by our CI.

[stefanwagnerdev]

I removed the example code as it requires login

[abey79]

Same

[stefanwagnerdev]

I removed the example code as it requires login

[abey79]

Please rename the directory wandelbots_nova. The _rerun part is superfluous given it's in the rerun repository :)

[abey79]

these needs to be named wandelbots_nova.py, since it should be a valid installable python package (no need to make a subdir + __init__.py though, as long as it fits a single file).

[stefanwagnerdev]

I removed the example code as it requires login

[abey79]

Let's not leak tooling specific stuff here.

[stefanwagnerdev]

I removed the example code as it requires login

[abey79]

This needs to be fleshed out to be an installable pyproject.toml, so it needs to specify a build backend. See our other examples. I would strongly suggest using hatch for that purpose, for consistency reason.

[stefanwagnerdev]

I removed the example code as it requires login

[abey79]

This is unideal. See main review comment.

[stefanwagnerdev]

Since it is in another project should I leave this here or should I remove it and let the explanation be in https://github.com/wandelbotsgmbh/wandelbots-nova ?

[stefanwagnerdev]

Is there anyway you could make this example work without login, e.g. by pointing on a public endpoint/dataset, or downloading static data instead of connecting to a live service?

Since the example is controlling a robot (virtual or real one) this will only work with a login as for now. :/
I could provide a final rrd file for the example? But I assume this is also not ideal since this can break in a new rerun release?

The project itself is also on Github with similar examples https://github.com/wandelbotsgmbh/wandelbots-nova
So I guess I just remove the example here since it will require credentials and only leave the readme?

[abey79]

Is there anyway you could make this example work without login, e.g. by pointing on a public endpoint/dataset, or downloading static data instead of connecting to a live service?

Since the example is controlling a robot (virtual or real one) this will only work with a login as for now. :/ I could provide a final rrd file for the example? But I assume this is also not ideal since this can break in a new rerun release?

Correct. All of our example are based on datafile that are converted to RRD by the example itself. We will not have rrd backward compatibility until Rerun 1.0 (and our path to that will incur a lot of breaking change in the next few releases).

The project itself is also on Github with similar examples wandelbotsgmbh/wandelbots-nova So I guess I just remove the example here since it will require credentials and only leave the readme?

Readme-only examples on this repo exist only for the purpose of being listed on our landing page (which pulls data from this repo for examples and some other stuff). At this point, I'm not entirely sure that this is a good item to have there, because there is actually very little Rerun SDK content that is visible (since your tooling already implements the bridge—which is great!), and it doesn't offer a way to easily see rerun in action (since this is gated by a registration process and a login). I will double-check that with the team.