Isaac Gym Python Stubs for Code Completion

Enable code completion for IsaacGym simply with pip install isaacgym-stubs, even without IsaacGym itself!

# Install from PyPi
pip3 install isaacgym-stubs

# Alternatively, install from Github
# pip3 install git+https://github.com/yzqin/isaacgym-stubs.git

The magic of stub is that you even do not need to pip install IsaacGym itself.

For example, you may want to run IsaacGym on server but develop the code on a MacBook. IsaacGym may not support Mac. But you can still install this repo on MacBook and get smooth code completion during development!

VsCode

PyCharm

This repository contains the pyi stub for the IsaacGym library, which can be used for code completion and type checking. According to the guidelines outlined in PEP-561, Python stub files contain only type information and no runtime code. The stub in this repo is generated based on IsaacGym version 1.0rc4.

Depending on which IDE you are using, sometimes you may need to restart the IDE after pip install for re-indexing.

See here for more explanation.