peeler 0.11.2

A tool to use a pyproject.toml instead of a blender_manifest.toml to build Blender add-ons

Peeler – Simplify Your Blender Add-on Packaging

Feel free to ask for help here or open an issue here.

A tool to easily package your Blender add-on

Building and installing a Blender add-on with dependencies requires manually downloading the necessary wheels and specifying their paths in blender_manifest.toml. Peeler automates this process, allowing you to package your Blender add-on without manually handling dependencies (and their own dependencies !) or manually writing their paths in blender_manifest.toml.

Since Blender 4.2, add-ons must use blender_manifest.toml instead of the standard pyproject.toml used in Python projects. Peeler lets you use pyproject.toml instead (or alongside) to simplify dependency management and streamline your workflow.

Installation

You can install Peeler with your favorite package manager (pip, uv, pipx, etc.). To get started, simply run:

pip install peeler

If you use uv Peeler does not need to be added to your project dependencies - you can use Peeler directly as a tool:

uvx peeler [OPTIONS] COMMAND [ARGS]

Features

Each feature can be used independently.

🛠️ Manifest

Generate a blender_manifest.toml file from your pyproject.toml fields.

📦 Wheels

Automatically download the required wheels from your add-on’s dependencies specified in your pyproject.toml and write their paths to blender_manifest.toml.

Manifest

Generate the blender_manifest.toml from fields in a pyproject.toml.

1. Ensure your pyproject.toml contains basic field values

# pyproject.toml

[project]
name = "MyAwesomeAddon"
version = "1.0.0"
requires-python = "==3.11.*"

2. Some metadata are specific to Blender

For instance blender_version_min, you can specify these metadata in your pyproject.toml file under the [tool.peeler.manifest] table Here's a minimal working version:

# pyproject.toml

[project]
name = "MyAwesomeAddon"
version = "1.0.0"
requires-python = "==3.11.*"

[tool.peeler.manifest]
blender_version_min = "4.2.0"
id = "my_awesome_add_on"
license = ["SPDX:0BSD"]
maintainer = "John Smith"
tagline = "My Add-on is awesome"

3. Run Peeler to create (or update) your blender_manifest.toml

peeler manifest /path/to/your/pyproject.toml /path/to/blender_manifest.toml

# Generated blender_manifest.toml

version = "1.0.0"
name = "MyAwesomeAddon"
schema_version = "1.0.0"
type = "add-on"
blender_version_min = "4.2.0"
id = "my_awesome_add_on"
license = ["SPDX:0BSD"]
maintainer = "John Smith"
tagline = "My Add-on is awesome"

The manifest is populated with values from your pyproject.toml [project] and [tool.peeler.manifest] tables, along with default values.

For a full list of required and optional values in a blender_manifest.toml visit Blender Documentation

4. Build your add-on

If your add-on has dependencies make sure to use the Wheels feature below.

Then to build your add-on use the regular Blender command:

blender --command extension build

Hint: Ensure Blender is added to your PATH

Wheels

Download the required wheels for packaging your add-on based on the dependencies specified in your pyproject.toml, automatically write their paths to blender_manifest.toml.

0. Installation

Peeler Wheels feature relies on a lockfile 📄 to work.

Currently supported lockfile formats:

• :snake: Python PEP 751 pylock.toml
• 🚀 uv uv.lock

Use your favorite tool such as PDM or uv to generate a pylock.toml file.

If you don't have a tool yet, just run:

pip install peeler[uv]

Then sit back and let Peeler handle it for you 😄

1. In your pyproject.toml, specify your dependencies

# pyproject.toml

[project]
name = "MyAwesomeAddon"
version = "1.0.0"
requires-python = "==3.11.*"

# For instance rich and Pillow (the popular image manipulation module)

dependencies = [
    "Pillow==11.1.0",
    "rich>=13.9.4",
]

2. Run peeler wheels to download the wheels for all platforms

peeler wheels ./pyproject.toml ./blender_manifest.toml

Peeler updates your blender_manifest.toml with the downloaded wheels paths.

# Updated blender_manifest.toml

version = "1.0.0"
name = "MyAwesomeAddon"
schema_version = "1.0.0"
type = "add-on"
blender_version_min = "4.2.0"

# The wheels as a list of paths
wheels = [
    # Pillow wheels for all platforms
    "./wheels/pillow-11.1.0-cp311-cp311-macosx_10_10_x86_64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-macosx_11_0_arm64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-manylinux_2_28_aarch64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-manylinux_2_28_x86_64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-musllinux_1_2_aarch64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-musllinux_1_2_x86_64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-win32.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-win_amd64.whl",
    "./wheels/pillow-11.1.0-cp311-cp311-win_arm64.whl",

    # Wheels for rich and its dependencies
    "./wheels/rich-13.9.4-py3-none-any.whl",
    "./wheels/markdown_it_py-3.0.0-py3-none-any.whl",
    "./wheels/mdurl-0.1.2-py3-none-any.whl",
    "./wheels/pygments-2.18.0-py3-none-any.whl"
]

Note that the dependencies of the dependencies (and so on) specified in pyproject.toml are also downloaded, ensuring everything is packaged correctly. Pretty neat, right?

# Pillow and rich dependency tree resolved from
# dependencies = [
#    "Pillow==11.1.0",
#    "rich>=13.9.4",
# ]

MyAwesomeAddon on v1.0.0
├── pillow v11.1.0
├── rich v13.9.4
│   ├── markdown-it-py v3.0.0
│   │   └── mdurl v0.1.2
│   └── pygments v2.18.0

Options

Exclude a package from being downloaded

Use --exclude-package PACKAGE to prevent wheels for this package from being downloaded.

Useful for packages already bundled with Blender (e.g. numpy) that have to be part of dependency resolution.

Example:

peeler wheels --exclude-package numpy

This option can be used multiple times:

peeler wheels --exclude-package bpy --exclude-package numpy

Exclude a dependency from dependency resolution

Use --exclude-dependency DEPENDENCY to prevent wheels for this dependency from being downloaded.

Useful for dependencies not used in production (e.g. fake-bpy-module).

Example:

peeler wheels --exclude-dependency fake-bpy-module

This option can be used multiple times:

peeler wheels --exclude-dependency fake-bpy-module --exclude-dependency pip

This option requires a pyproject.toml file and uv (https://astral.sh/blog/uv)

Exclude a dependency group from dependency resolution

Use --exclude-dependency-group DEPENDENCY_GROUP to prevent wheels for this dependency group from being downloaded.

Useful for dependency groups not used in production.

# pyproject.toml

[dependency-groups]
docs = ["sphinx"]
coverage = ["coverage[toml]"]
test = ["pytest>7", {include-group = "coverage"}]

Example:

peeler wheels --exclude-dependency-group dev

This option can be used multiple times:

peeler wheels --exclude-dependency-group dev --exclude-dependency-group test

This option requires a pyproject.toml file and uv (https://astral.sh/blog/uv)

See more on dependency groups on python.org

Authors

• Maxime Letellier - Initial work