Skip to content

Abstract

Easily install the bpy_jupyter extension.

Ready to use bpy_jupyter? See User Guides / Getting Started.

Installation

To install bpy_jupyter, Blender 3D must already be installed.

Install from extensions.blender.org

Warning

This method is planned, but not yet implemented.

Stay tuned!

Install from GitHub Release

Navigate to the bpy_jupyter GitHub releases, and download the build extension .zip corresponding to your platform.

After downloading, drag-and-drop the .zip file into Blender to install it.

Install from Source

Warning: uv Required

It is strongly suggested to install uv before following this installation method, using the uv installation guide.

Tip

bpy_jupyter is built using an unreleased preview version of the blext tool.

As blext matures, this section may change. Stay tuned!

First, clone the repository using git: 

git clone https://github.com/Octoframes/bpy_jupyter.git
cd bpy_jupyter

You can now git checkout a particular commit, or simply stick to the latest commit on main.

Either way, to run bpy_jupyter in your locally installed Blender, execute the following within the cloned repository: 

$ uv run --locked blext run

To build .zip files for all supported platforms and Blender versions, execute the following: 

$ uv run --locked blext run

The extension .zips will be available in the build/ folder of the project root, from where they can be drag-and-dropped into Blender for installation.