Skip to main content

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

Note: The similar project for Blender Game Engine (BGE) is available on `fake-bge-module <https://github.com/nutti/fake-bge-module>`__ which targets `UPBGE <https://upbge.org/>`__.

Requirements

fake-bpy-module uses typing module and type hints which are available from Python 3.7. Check your Python version is >= 3.7.

Install

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

Install via pip package

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.93, run below command.

pip install fake-bpy-module-2.93

If you install fake-bpy-module for Blender latest build (master branch daily build powered by nutti/blender-daily-build), run below command.

pip install fake-bpy-module-latest

Note: For PyCharm users, change the value ``idea.max.intellisense.filesize`` in ``idea.properties`` file to more than 2600 because some modules have the issue of being too big for intelliSense to work.

Supported Blender Version

Version

PyPI

2.78

https://pypi.org/project/fake-bpy-module-2.78/

2.79

https://pypi.org/project/fake-bpy-module-2.79/

2.80

https://pypi.org/project/fake-bpy-module-2.80/

2.81

https://pypi.org/project/fake-bpy-module-2.81/

2.82

https://pypi.org/project/fake-bpy-module-2.82/

2.83

https://pypi.org/project/fake-bpy-module-2.83/

2.90

https://pypi.org/project/fake-bpy-module-2.90/

2.91

https://pypi.org/project/fake-bpy-module-2.91/

2.92

https://pypi.org/project/fake-bpy-module-2.92/

2.93

https://pypi.org/project/fake-bpy-module-2.93/

3.0

https://pypi.org/project/fake-bpy-module-3.0/

3.1

https://pypi.org/project/fake-bpy-module-3.1/

3.2

https://pypi.org/project/fake-bpy-module-3.2/

latest

https://pypi.org/project/fake-bpy-module-latest/

Install via pre-generated modules

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.

Generate Modules Manually

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

Change Log

See CHANGELOG.md

Bug report / Feature request / Disscussions

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

fake-bpy-module channel is available on blender.chat.
The timely discussion and release announcement about fake-bpy-module will be made in this channel.

Note: Registration of blender.chat is required for accessing fake-bpy-module channel.

Contribution

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

Project Authors

Owner

**@nutti**

Indie Game/Application Developer.
Especially, I spend most time to improve Blender and Unreal Game Engine via providing the extensions.

Support via GitHub Sponsors

Contributors

Metadata

Release files for fake-bpy-module-2.81 20220615

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fake-bpy-module-2.81 20220615
File Size Uploaded
fake-bpy-module-2.81-20220615.tar.gz 588.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fake-bpy-module-2.81 20220615
File Interpreter ABI Platform
fake_bpy_module_2.81-20220615-py3-none-any.whl Python 3 none any Details

Total release size: 1.3 MB

Release files / fake-bpy-module-2.81-20220615.tar.gz

Download URL fake-bpy-module-2.81-20220615.tar.gz
Size 588.2 kB
Tags Source
SHA-256 checksum
How to use checksums
84f1c875656ea9460491be7cf8db1c7bde3afa9ee0e7ea1758eeee7d1e25e873
BLAKE2b-256 checksum
How to use checksums
e82c7daaf8a4073fff70b9ae0dc4ed29cb6f78aff8766115014ad52b64616bd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.13

Release files / fake_bpy_module_2.81-20220615-py3-none-any.whl

Download URL fake_bpy_module_2.81-20220615-py3-none-any.whl
Size 700.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6029d5f549886d9edf1423d5bb08a021227cf77a757e44a2a08abf7df6b52983
BLAKE2b-256 checksum
How to use checksums
d31b348595a4887ae8d1308cc408e395dcd2d670af97b91a97928fa56a231929
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.13
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page