[jiwenc-nv]

Description

Part of #985. Stacked on #1044.

No flat sibling imports — the two scripts are independent — but the tree ran as uv run <script>.py from its own directory, so it needed the same conversion as the rest for one install command to work across every example.

uv pip install -e ./examples/cloudxr_mujoco_teleop
python -m isaacteleop_examples.cloudxr_mujoco_teleop.visualize_poses_mujoco_example

vive_assets/ moves inside the package: both scripts resolve ASSETS_DIR from __file__, so the meshes have to travel with the modules or the move would silently break them. The wheel now carries them (6 asset files), matching how mujoco_xr ships its own assets.

The REUSE.toml override for examples/cloudxr_mujoco_teleop/** still covers the nested paths, so the HTC copyright is unaffected.

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 3 modules and all 6 vive_assets files under isaacteleop_examples/cloudxr_mujoco_teleop/, with no namespace __init__.py. pre-commit clean.

Not covered: both need a headset and a CloudXR runtime. The asset move is the part worth eyeing — if the meshes fail to load, ASSETS_DIR is the reason.

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 with no import changes.}

Summary by CodeRabbit

• Documentation

  • Updated setup and launch instructions for the CloudXR MuJoCo teleoperation example.
  • Revised example naming and directory layout documentation.

• Chores

  • Added package build configuration for distributing the example.
  • Added licensing information to the example module.

[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: 30df5469-cae0-4ec5-b5c3-c2f6ff4f5c14

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: a7f5a066-013f-4869-bfd7-c78a74592da4

📥 Commits

Reviewing files that changed from the base of the PR and between 82ce903 and fc71e0e.

⛔ Files ignored due to path filters (6)

• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/generic_hmd.obj is excluded by !**/*.obj
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/generic_hmd_color.png is excluded by !**/*.png
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/vive_focus3_controller_left.obj is excluded by !**/*.obj
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/vive_focus3_controller_left_color.png is excluded by !**/*.png
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/vive_focus3_controller_right.obj is excluded by !**/*.obj
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/vive_assets/vive_focus3_controller_right_color.png is excluded by !**/*.png

📒 Files selected for processing (5)

• examples/cloudxr_mujoco_teleop/README.md
• examples/cloudxr_mujoco_teleop/pyproject.toml
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/__init__.py
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/visualize_hands_mujoco_example.py
• examples/cloudxr_mujoco_teleop/python/isaacteleop_examples/cloudxr_mujoco_teleop/visualize_poses_mujoco_example.py

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

---

📝 Walkthrough

Walkthrough

The CloudXR MuJoCo teleop example now uses an installable Hatchling package. The package name, wheel contents, and Python source root are defined in pyproject.toml. The README now instructs users to install the package in editable mode and launch the poses and hands examples as modules. The documented directory layout reflects the new package structure. The package initializer now includes SPDX and Apache-2.0 license headers.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to fc71e

The example can be installed and launched through the documented package commands without an established merge-blocking defect.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: packaging the cloudxr_mujoco_teleop example under isaacteleop_examples.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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.

✨ Finishing Touches

📝 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: every Python file is a 100% rename, so the only new content is the pyproject.toml (only-include + sources, no __init__.py on the namespace) and the README path updates.

Not installed by install_python_example(), so there is no install tree to check.