Need help with blenderpy?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

TylerGubala
211 Stars 19 Forks GNU General Public License v3.0 243 Commits 24 Opened issues

Description

Blender as a python module with easy-install

Services available

!
?

Need anything else?

Contributors list

No Data

blenderpy

Blender as a python module with easy-install

About

Meant for installation into a virtualenv or wherever, for unit testing of Blender extensions being authored, or developement of a Blender 3d-enabled Python application.

Depends upon the

bpy-build
module to make sure the Blender
bpy
module environment is correct.

For more information, please see:

bpy-build repository

Getting Started

Prebuilt wheels are provided for popular Platforms (MacOS, Windows, and

manylinux
). Prebuilds are complete builds with audio, CUDA, and Optix functionality (except for MacOS, which is missing those three), like you would expect with installing the complete application.

Prerequisites

Both building the Python package from sources and installing the

wheel
files require the bare minimum dependencies listed on the Blender 3D wiki for building Blender. Get these first before opening a new issue.

Installing

Installing from

pypi
:

pip install bpy && bpy_post_install

Installing from

wheel
file (see Releases page):

pip install  && bpy_post_install

Uninstalling

A unique uninstallation script is required to ensure that all traces of

bpy
are removed from the hard drive, because Blender expects
.dll
and
.so
libraries to be in places that are not part of the Python packaging system.

bpy_pre_uninstall && pip uninstall bpy

Building

See more about building

bpy
on the wiki page.

FAQ

Q. I am getting
failed to find 'bpy_types' module

A. Please see issue #13

Q. I am getting
ImportError: DLL load failed: The specified module could not be found

A. Please see issue #15

Q. How do I import addons?

A. Addons (Blender internal and third party) can be imported using the code referenced here.

Q. How can I use Blender in
multiprocessing
?

A. Blender runtime usage and compatibility with

multiprocessing
is limited, see the documentation.

Q. What about my operating system of choice?

A. Please file a new issue if you are having trouble installing on your operating system of choice.

Q. What about my Python version of choice?

A. Some builds you will have to make yourself if you have a specific version of the API you want. Likewise, if you are contrained to a specific Python version (especially those that aren't shipped by python.org) then you may have to try and build yourself.

Q. What about my bitness of choice?

A. 32-bit support officially ended with

2.80
. See the announcement

Gotchas

Some unique hardware and software configurations may not work, and there is no extant list of things that don't work in the Python standalone module.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.