Skip to content

examples(haptic_feedback): package under isaacteleop_examples - #1044

Merged
jiwenc-nv merged 0 commit into
jiwenc-nv/examples-lerobotfrom
jiwenc-nv/examples-haptic-feedback
Sep 18, 2026
Merged

jiwenc-nv merged 0 commit into
jiwenc-nv/examples-lerobotfrom
jiwenc-nv/examples-haptic-feedback

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Aug 28, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Part of #985. Stacked on #1043.

No flat sibling imports here — the two examples are independent — but the tree kept its pyproject.toml under python/ and its README documented uv run <script>.py, so it needed the same conversion as the rest for one install command to work across every example.

uv pip install -e ./examples/haptic_feedback
python -m isaacteleop_examples.haptic_feedback.controller_haptic_example

device/haptic_feedback.rst follows: it pointed at examples/haptic_feedback/python/ and told the reader to run from that directory.

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/haptic_feedback/ with no namespace __init__.py. pre-commit clean.

Not covered: both examples need a controller or a haptic glove plus a running CloudXR/OpenXR runtime.

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 at all.

Summary by CodeRabbit

  • Documentation

    • Updated haptic feedback example instructions to install the package and run examples as Python modules.
    • Standardized example naming and updated referenced paths.
  • New Features

    • Added packaging configuration for installing the haptic feedback example with supported Python versions and required dependencies.
  • Chores

    • Moved the example installation destination to the package root.
    • Removed the previous Python-specific project configuration.
    • Added licensing headers to the example module.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

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: 367fc837-9c01-400a-be53-748d2e733305

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: 7e5022db-6e64-456a-b5b2-3bc71ade8320

📥 Commits

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

📒 Files selected for processing (8)
  • docs/source/device/haptic_feedback.rst
  • examples/haptic_feedback/CMakeLists.txt
  • examples/haptic_feedback/README.md
  • examples/haptic_feedback/pyproject.toml
  • examples/haptic_feedback/python/isaacteleop_examples/haptic_feedback/__init__.py
  • examples/haptic_feedback/python/isaacteleop_examples/haptic_feedback/controller_haptic_example.py
  • examples/haptic_feedback/python/isaacteleop_examples/haptic_feedback/hand_pinch_haptic_example.py
  • examples/haptic_feedback/python/pyproject.toml
💤 Files with no reviewable changes (1)
  • examples/haptic_feedback/python/pyproject.toml

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


📝 Walkthrough

Walkthrough

The haptic feedback example now has a package-level Hatch configuration with Python version bounds, dependencies, and wheel settings. The previous nested project configuration was removed. CMake now installs the example at the package root. The README and device documentation now use editable installation and python -m execution with module paths. The package initializer now includes copyright and license metadata.

Priority: ➖ Normal

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

Merge Risk: ⚪ Minimal · up to 82ce9

No merge-blocking packaging or execution issue was identified.

🚥 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 haptic feedback examples under the isaacteleop_examples namespace.
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.

@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 6de3608 to 5b6ecc9 Compare August 28, 2026 05:01
@jiwenc-nv
jiwenc-nv changed the base branch from jiwenc-nv/examples-deviceio-live-view to jiwenc-nv/examples-lerobot August 28, 2026 05:02
@jiwenc-nv
jiwenc-nv requested a review from ivany-nv August 28, 2026 05:11
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 5b6ecc9 to 98868de Compare August 28, 2026 05:23
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 98868de to 6060c4c Compare August 28, 2026 05:32
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 6060c4c to e047f6c Compare August 28, 2026 05:44
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from e047f6c to f362638 Compare August 28, 2026 05:49

@ivany-nv ivany-nv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read the diff line by line: pure move, no content change to either module.

Verified the install tree lands correctly at the stack tip (pyproject.toml at the example root, no doubled python/python/, no isaacteleop_examples/__init__.py), and python -m isaacteleop_examples.haptic_feedback.controller_haptic_example --help runs from install/examples/haptic_feedback/.

@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from f362638 to 1a6f010 Compare August 28, 2026 14:46
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 1a6f010 to 47d5e7a Compare August 28, 2026 16:11
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch 2 times, most recently from 67c01ac to c92f305 Compare August 29, 2026 00:21
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from c92f305 to 441c10f Compare August 29, 2026 01:19
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 441c10f to 0f466a6 Compare August 30, 2026 16:23
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 0f466a6 to 2211238 Compare August 31, 2026 15:09
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 2211238 to 4237c48 Compare September 2, 2026 16:13
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 4237c48 to e2d9098 Compare September 3, 2026 15:54
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from e2d9098 to 271c2f5 Compare September 3, 2026 22:13
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch from 271c2f5 to 82ce903 Compare September 18, 2026 15:39
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-haptic-feedback branch 2 times, most recently from d87335e to 170f4b8 Compare September 18, 2026 16:18
@jiwenc-nv
jiwenc-nv merged commit 170f4b8 into main Sep 18, 2026
13 of 25 checks passed
@jiwenc-nv
jiwenc-nv deleted the jiwenc-nv/examples-haptic-feedback branch September 18, 2026 16:19
github-actions Bot added a commit that referenced this pull request Sep 18, 2026
github-actions Bot added a commit that referenced this pull request Sep 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants