Add example template

examples/README.md

@@ -40,3 +40,8 @@ python: https://github.com/rerun-io/rerun/tree/latest/examples/python/tracking_h
 The contents of this `README.md` file and its frontmatter are used to render the examples in [the documentation](https://rerun.io/examples). Individual examples are currently "stitched together" to form one large markdown file for every category of examples (`artificial-data`, `real-data`).
 
 The `manifest.yml` file describes the structure of the examples contained in this repository. Only the examples which appear in the manifest are included in the [generated documentation](https://rerun.io/examples). The file contains a description of its own format.
+
+## Adding a new example
+
+You can base your example off of `python/template` or `rust/template`.
+Once it's ready to be displayed in the docs, add it to the [manifest](./manifest.yml).

examples/python/requirements.txt

@@ -21,5 +21,6 @@
 -r ros/requirements.txt
 -r segment_anything/requirements.txt
 -r stable_diffusion/requirements.txt
+-r template/requirements.txt
 -r text_logging/requirements.txt
 -r tracking_hf_opencv/requirements.txt

examples/python/template/README.md

@@ -0,0 +1,15 @@
+---
+title: Template
+tags: [kebab-case, comma, separated]
+python: https://github.com/rerun-io/rerun/tree/latest/examples/python/template/main.py
+rust: https://github.com/rerun-io/rerun/tree/latest/examples/rust/template/src/main.rs
+---
+
+<!-- Place a screenshot here -->
+
+This is an example example. It is not a real example. You can duplicate the directory and use it as a starting point for writing a real example.
+
+```bash
+pip install -r examples/python/template/requirements.txt
+examples/python/template/main.py
+```

examples/python/template/main.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+"""
+Example template.
+
+Run:
+```sh
+pip install -r examples/python/template/requirements.txt
+./examples/python/template/main.py
+```
+"""
+from __future__ import annotations
+
+import argparse
+import logging
+
+import rerun as rr  # pip install rerun-sdk
+
+
+def setup_logging() -> None:
+    # Forward all text logs to Rerun by attaching a handler directly to the root logger,
+    # which will catch events from all loggers going forward (propagation is on by
+    # default).
+    #
+    # For more info: https://docs.python.org/3/howto/logging.html#handlers
+    logging.getLogger().addHandler(rr.log.text.LoggingHandler())
+    logging.getLogger().setLevel(-1)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Describe your example here!")
+    rr.script_add_args(parser)
+    args = parser.parse_args()
+
+    rr.script_setup(args, "my_example_name")
+
+    setup_logging()
+
+    # ... example code
+
+    rr.script_teardown(args)
+
+
+if __name__ == "__main__":
+    main()

examples/python/template/requirements.txt

@@ -0,0 +1 @@
+rerun-sdk

examples/rust/template/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "template"
+version = "0.7.0-alpha.0"
+edition = "2021"
+rust-version = "1.69"
+license = "MIT OR Apache-2.0"
+publish = false
+
+[dependencies]
+rerun = { path = "../../../crates/rerun", features = ["native_viewer"] }

examples/rust/template/README.md

@@ -0,0 +1,15 @@
+---
+title: Template
+tags: [kebab-case, comma, separated]
+python: https://github.com/rerun-io/rerun/tree/latest/examples/python/template/main.py
+rust: https://github.com/rerun-io/rerun/tree/latest/examples/rust/template/src/main.rs
+---
+
+<!-- Place a screenshot here -->
+
+This is an example example. It is not a real example. You can duplicate the directory and use it as a starting point for writing a real example.
+
+```bash
+cargo run --release -p template
+```
+

examples/rust/template/src/main.rs

@@ -0,0 +1,15 @@
+//! Example template.
+
+use rerun::RecordingStreamBuilder;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let (rec_stream, storage) = RecordingStreamBuilder::new("my_example_name").memory()?;
+
+    let _ = rec_stream;
+
+    // ... example code
+
+    rerun::native_viewer::show(storage.take())?;
+
+    Ok(())
+}