examples(oglo_tactile): package under isaacteleop_examples

[jiwenc-nv]

Description

Part of #985. Stacked on #1041.

oglo_teleop_record.py imported oglo_heatmap as a top-level module, which resolved only because the invoked script's own directory landed on sys.path. This moves the tree to the layout in examples/README.md.

The example gains its first pyproject.toml, so the README's loose pip install pillow numpy / pip install cupy-cuda12x become an install of the example and its gpu extra. cupy stays optional — without it the renderer still writes PNGs and only the in-headset overlay is lost.

One path fix the move forces. _default_plugin_bin() walked up parents[2] to the repo root; three levels deeper that lands on the example's python/ directory. It is now parents[5], with a note that it only resolves from a source checkout — an installed copy lands in site-packages, where the existing PATH fallback takes over.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update

Testing

x86_64 / Ubuntu, Python 3.12. Wheel ships both modules under isaacteleop_examples/oglo_tactile/ with no namespace __init__.py. Editable-installed into a clean venv, both import with the CWD outside the repo; import oglo_heatmap fails. parents[5] verified to land on the repo root. pre-commit clean.

Not covered: nothing here has an OGLO glove. The dependency list is inferred from imports and this example never had one before, so a missing runtime dep would only show on the machine with the gloves attached.

Checklist

• I have read and understood the contribution guidelines
• I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
• I have made corresponding changes to the documentation
• I have added tests that prove my fix/feature works (or explained why not)
• I have signed off all my commits (git commit -s) per the DCO

_{No tests: this is a move, and no CI has the hardware.}

Summary by CodeRabbit

• New Features

  • The OGLO tactile recording example can now be installed as a package.
  • Optional GPU support is available for headset overlays, while recording remains available without GPU dependencies.
  • The example supports Python 3.11–3.13 and can be launched through its installed command/module.

• Bug Fixes

  • Improved executable discovery so the recording demo works reliably both from source checkouts and installed environments.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ac27e986-ee3d-4e9a-a5e1-7d73983df92f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fa98bf15-c0d6-423f-aa1c-0db4d4b6d5d3

📥 Commits

Reviewing files that changed from the base of the PR and between c376eeb and 3850c8a.

📒 Files selected for processing (5)

• examples/oglo_tactile/README.md
• examples/oglo_tactile/pyproject.toml
• examples/oglo_tactile/python/isaacteleop_examples/oglo_tactile/__init__.py
• examples/oglo_tactile/python/isaacteleop_examples/oglo_tactile/oglo_heatmap.py
• examples/oglo_tactile/python/isaacteleop_examples/oglo_tactile/oglo_teleop_record.py

Included review availability: Your plan provides up to 12 included reviews per hour; 8 remain after this review.

---

📝 Walkthrough

Walkthrough

The OGLO tactile example now defines an installable package with core dependencies and an optional CUDA 12 GPU extra. Its recording module uses package-relative imports and updated plugin path resolution for source and installed layouts. The README installs the example through uv pip install -e and launches recording as an installed module.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 3850c

The OGLO example's documented installation and module execution paths remain compatible, with optional GPU failures limited to the overlay.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (2 skipped: 2 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: packaging the oglo_tactile example under the isaacteleop_examples namespace.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

_{Comment @coderabbitai help to get the list of available commands.}

[ivany-nv]

Read the diff line by line. Two changes beyond the move: the oglo_heatmap import becoming relative, and here.parents[2] becoming here.parents[5]. Checked the arithmetic — from python/isaacteleop_examples/oglo_tactile/, the repo root is five parents up, so that is right, and the comment about an installed copy falling through to the PATH lookup matches the code.

Not installed by install_python_example() and I have no OGLO hardware here, so nothing to run.