The usefulness of the rerun_demo package is decreasing and not really worth the cost of maintaining. In particular, it includes a demo RRD files which weighs on the wheels and on our CI, and bear little usefulness (the same file is available online and it's hard to install rerun w/o a connection anyways). For these reason, rerun_demo should be removed.
This task involves at least:
- move the utility functions that it contains to a new
rerun.utilities sub-package
- update the documentation (at least
getting-started/python.md, viewer-walkthrough.md, logging-python.md)
viewer-walkthrough.md benefits from having easy access to structure-from-motion example, it should point at the integrated example list for that instead
- update the quick start guides
- update the examples (at least
dna uses some of the utilities)
- update the
.ipynb
- remove the tests (
test_rerun_demo.py)
- update the CI
- remove the relevant config section
.mypy.ini
- remove the rerun_demo-specific config in
pyrightconfig.json
- update the doc generation script (
gen_common_index)
- update pyproject.toml
The usefulness of the
rerun_demopackage is decreasing and not really worth the cost of maintaining. In particular, it includes a demo RRD files which weighs on the wheels and on our CI, and bear little usefulness (the same file is available online and it's hard to install rerun w/o a connection anyways). For these reason,rerun_demoshould be removed.This task involves at least:
rerun.utilitiessub-packagegetting-started/python.md,viewer-walkthrough.md,logging-python.md)viewer-walkthrough.mdbenefits from having easy access to structure-from-motion example, it should point at the integrated example list for that insteaddnauses some of the utilities).ipynbtest_rerun_demo.py).mypy.inipyrightconfig.jsongen_common_index)