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

examples/api_demo -> tests/test_api #2585

Merged
merged 7 commits into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 0 additions & 4 deletions examples/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,6 @@ root:
python: python/minimal
rust: rust/minimal

- name: api-demo
python: python/api_demo
rust: rust/api_demo

- name: car
python: python/car

Expand Down
22 changes: 0 additions & 22 deletions examples/python/api_demo/README.md

This file was deleted.

1 change: 0 additions & 1 deletion examples/python/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
-r api_demo/requirements.txt
-r arkit_scenes/requirements.txt
-r blueprint/requirements.txt
-r car/requirements.txt
Expand Down
12 changes: 2 additions & 10 deletions examples/rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ To try out any example in the list that follows, simply run `cargo run -p <examp

By default, the examples spawn a Rerun Viewer and stream log data to it.

You can instead save the log data to an `.rrd` file using `cargo run -p api_demo -- --save data.rrd`. You can then open that `.rrd` file with `rerun data.rrd` or `cargo run -- data.rrd`.
You can instead save the log data to an `.rrd` file using `cargo run -p objectron -- --save data.rrd`. You can then open that `.rrd` file with `rerun data.rrd` or `cargo run -- data.rrd`.

NOTE: `.rrd` files do not yet guarantee any backwards or forwards compatibility. One version of Rerun will likely not be able to open an `.rrd` file generated by another Rerun version.

### Additional settings

Most examples come with a set of predefined Rerun flags and optionally a number of example-specific flags.
Use e.g. `cargo run -p api_demo -- --help` for a detailed listing.
Use e.g. `cargo run -p objectron -- --help` for a detailed listing.

The predefined Rerun flags go as follow and are all mutually exclusive:
- `--spawn`: start a viewer and feed it data in real-time (default behavior)
Expand Down Expand Up @@ -46,14 +46,6 @@ A minimal example, showing how to log a point cloud.
<img src="https://static.rerun.io/0e47ac513ab25d56cf2b493128097d499a07e5e8_minimal_full.png" alt="Minimal example screenshot">
</picture>

### [`api_demo`](api_demo)

`cargo run -p api_demo`

An amalgamation of various usages of the API with synthetic "data" without any particular focus.

It demonstrates a lot of different aspects of the Rerun API.

### [`objectron`](objectron)

`cargo run -p objectron`
Expand Down
22 changes: 0 additions & 22 deletions examples/rust/api_demo/README.md

This file was deleted.

10 changes: 5 additions & 5 deletions examples/rust/custom_space_view/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Custom Space View UI
rust: https://github.com/rerun-io/rerun/tree/latest/examples/rust/custom_space_view/src/main.rs
thumbnail: https://static.rerun.io/d41179fb380bc6bdeda950d7d69e3c457ff295e9_api_demo_480w.png
thumbnail: https://static.rerun.io/0ddce48924e92e4509c4caea3266d414ad76d961_custom_space_view_480w.jpeg
---

<picture>
<source media="(max-width: 480px)" srcset="https://static.rerun.io/0ddce48924e92e4509c4caea3266d414ad76d961_api_demo_480w.jpeg">
<source media="(max-width: 768px)" srcset="https://static.rerun.io/07fc2ec0fb45bd282cd942021bec82a8bf22929d_api_demo_768w.jpeg">
<source media="(max-width: 1024px)" srcset="https://static.rerun.io/2411b2c296230079e33bf075020510f10ccf086f_api_demo_1024w.jpeg">
<source media="(max-width: 1200px)" srcset="https://static.rerun.io/44ad47af559fbdd45aab5a663992f31e80876793_api_demo_1200w.jpeg">
<source media="(max-width: 480px)" srcset="https://static.rerun.io/0ddce48924e92e4509c4caea3266d414ad76d961_custom_space_view_480w.jpeg">
<source media="(max-width: 768px)" srcset="https://static.rerun.io/07fc2ec0fb45bd282cd942021bec82a8bf22929d_custom_space_view_768w.jpeg">
<source media="(max-width: 1024px)" srcset="https://static.rerun.io/2411b2c296230079e33bf075020510f10ccf086f_custom_space_view_1024w.jpeg">
<source media="(max-width: 1200px)" srcset="https://static.rerun.io/44ad47af559fbdd45aab5a663992f31e80876793_custom_space_view_1200w.jpeg">
<img src="https://static.rerun.io/dc8cfa50e309ba2e2cd2b7647391cd74b7a0477f_api_demo_full.jpeg" alt="Custom Space View UI example screenshot">
</picture>

Expand Down
2 changes: 1 addition & 1 deletion scripts/run_all.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def collect_examples(fast: bool) -> list[str]:
if fast:
# cherry-picked
return [
"examples/python/api_demo",
"tests/python/test_api",
"examples/python/car",
"examples/python/clock",
"examples/python/dicom_mri",
Expand Down
4 changes: 2 additions & 2 deletions scripts/run_python_e2e_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def main() -> None:

if not parser.parse_args().no_pip_reqs:
requirements = [
"examples/python/api_demo/requirements.txt",
"tests/python/test_api/requirements.txt",
"examples/python/car/requirements.txt",
"examples/python/minimal_options/requirements.txt",
"examples/python/multithreading/requirements.txt",
Expand All @@ -60,7 +60,7 @@ def main() -> None:

examples = [
# Trivial examples that don't require weird dependencies, or downloading data
("examples/python/api_demo/main.py", ["--demo", "all"]),
("tests/python/test_api/main.py", ["--test", "all"]),
("examples/python/car/main.py", []),
("examples/python/minimal_options/main.py", []),
("examples/python/multithreading/main.py", []),
Expand Down
1 change: 1 addition & 0 deletions tests/python/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-r test_api/requirements.txt
Loading
Loading