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 for the latest 1.0rc4 version (preview 4), the 1.1rc4 of this package means enhanced stub, it still corresponds to isaacgym 1.0rc4
pip3 install isaacgym-stubs

# Install it for other IsaacGym version, e.g. preview 3
pip3 install isaacgym_stubs==1.0rc3

# Or preview 2
pip3 install isaacgym_stubs==1.0rc2

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

Begin your code with the typical from isaacgym import gymapi and enjoy auto-completion.

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!

Demo

VsCode

PyCharm

Troubleshooting

1. The Python interpreter specified in your IDE should be the Python where isaacgym-stubs is installed. For example, if you install this repository with conda Python but select the system Python as the interpreter in your IDE, you won't have any code auto-completion. Follow the official instruction here for VSCode and here for PyCharm.
2. Code auto-completion will not function if there's a directory named issacgym in your workspace. In this case, the isaacgym symbol in your import will point to the directory instead of this package, disrupting the auto-completion. Ensure that there's no isaacgym directory in your IDE workspace.
3. Depending on which IDE you are using, sometimes you may need to restart the IDE after pip install for re-indexing.

Overview

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.

Generating Enhanced pyi Files

The base .pyi files are typically created using tools like mypy or pybind11-stubgen. For improved documentation, Lai Wei has developed an automated script that extracts information from IsaacGym documentation to produce more descriptive and useful .pyi files. For additional information, refer to issue #2.