fake-bpy-module is the collections of the fake Blender Python API modules for the code completion in commonly used IDEs.

fake-bpy-module uses typing module and type hints availabled from Python 3.6. Check your Python version is >= 3.6.

fake-bpy-module can be installed via a pip package, or pre-generated modules. You can also generate and install modules manually.

fake-bpy-module is registered to PyPI.
You can install it as a pip package.

pip install fake-bpy-module-<version>

If you install fake-bpy-module for Blender 2.8, run below command.

pip install fake-bpy-module-2.80

Download Pre-generated modules from Release page.

The process of installation via pre-generated modules is different by IDE. See the installation processes as follows for detail.

• PyCharm
• Visual Studio Code
• All Text Editor (Install as Python module)

You can also generate modules manually. See Generate Module for detail.

If you want to report bug, request features or discuss about this add-on, see ISSUES.md.

If you want to contribute to this project, see CONTRIBUTING.md.