Skip to main content

Collection of the fake Blender Python API module for the code completion.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fake-bpy-module-2.83-20220615.tar.gz (616.5 kB view details)

Uploaded Source

Built Distribution

fake_bpy_module_2.83-20220615-py3-none-any.whl (728.5 kB view details)

Uploaded Python 3

File details

Details for the file fake-bpy-module-2.83-20220615.tar.gz.

File metadata

File hashes

Hashes for fake-bpy-module-2.83-20220615.tar.gz
Algorithm Hash digest
SHA256 a6075dbee82e44ef19c75c023fd1474a29545bf18630666eeffe78b0657ec98e
MD5 a50d5bf3d67d69b9937183233c127acc
BLAKE2b-256 34b7f89ce58ca2a7de4aa3be2c78826921d23b6f122d0ed22e6f8f87e196a016

See more details on using hashes here.

File details

Details for the file fake_bpy_module_2.83-20220615-py3-none-any.whl.

File metadata

File hashes

Hashes for fake_bpy_module_2.83-20220615-py3-none-any.whl
Algorithm Hash digest
SHA256 6453ea961a03fcda0052541bc37f63faba273e42923cb45502578ab99a11705e
MD5 0e6fcef8673807360da102b8362f88ef
BLAKE2b-256 a2c34b9013b3ad62dd767f04ee1d35a5c08b8e6e8bc6c18687af29ca23768ee9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page