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

Jump to bottom

Remove the rerun_demo #3915

Closed
abey79 opened this issue Oct 18, 2023 · 0 comments · Fixed by #4293
Closed

Remove the rerun_demo #3915

abey79 opened this issue Oct 18, 2023 · 0 comments · Fixed by #4293
Assignees
@abey79
Labels
🐍 Python API Python logging API
Milestone
0.11

Comments

@abey79
Copy link
Member

abey79 commented Oct 18, 2023

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
@abey79 abey79 added the 🐍 Python API Python logging API label Oct 18, 2023
@abey79 abey79 added this to the 0.11 C++ polish milestone Oct 18, 2023
@abey79 abey79 mentioned this issue Oct 24, 2023
Merged
4 tasks
abey79 added a commit that referenced this issue Oct 25, 2023
@abey79
Remove mention of rerun_sdk in Python Quick Start guides (#3986)
511913b 
### What

* Closes #3955
* Relates to #3915

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3986) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/3986)
- [Docs
preview](https://rerun.io/preview/56b1cdd6768c4ef97f36f167bf259167c01a9eb2/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/56b1cdd6768c4ef97f36f167bf259167c01a9eb2/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@teh-cmc teh-cmc mentioned this issue Oct 27, 2023
Merged
4 tasks
@jprochazk jprochazk assigned jprochazk and unassigned jprochazk Nov 15, 2023
@abey79 abey79 mentioned this issue Nov 21, 2023
Merged
14 tasks
abey79 added a commit that referenced this issue Nov 22, 2023
@abey79
Remove deprecated rerun_demo package (#4293)
55d8133 
### What

Remove deprecated `rerun_demo` package. Move some of the utilities used
in example & tutorial in `rerun.utilities`.

TODO:
- [x] move the utility functions that it contains to a new
`rerun.utilities` sub-package
- [x] update the documentation (at least `getting-started/python.md`,
`viewer-walkthrough.md`, `logging-python.md`)
- [x] update the quick start guides
- [x] update the examples (at least `dna` uses some of the utilities)
- [x] update the `.ipynb`
- [x] remove the tests (`test_rerun_demo.py`)
- [x] remove the relevant config section `.mypy.ini` 
- [x] remove the rerun_demo-specific config in `pyrightconfig.json`
- [x] update the doc generation script (`gen_common_index`)
- [x] update pyproject.toml

* Closes #3915

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/4293) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4293)
- [Docs
preview](https://rerun.io/preview/72e2579754cb2dabb27d07625249940531209996/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/72e2579754cb2dabb27d07625249940531209996/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abey79 abey79

Labels
🐍 Python API Python logging API
Projects
None yet
Milestone
0.11
Development

Successfully merging a pull request may close this issue.

Remove deprecated rerun_demo package rerun-io/rerun
2 participants
@jprochazk @abey79