Pyblish integration for Blender.

What is included?

A set of common plug-ins and functions shared across other integrations - such as getting the current working file. It also visually integrates Pyblish into the File-menu for easy access.

• Common plug-ins
• Common functionality
• File-menu shortcut

Installation

pyblish-blender depends on pyblish-base and is available via PyPI.

$ pip install pyblish-blender

You may also want to consider a graphical user interface, such as pyblish-qml or pyblish-lite.

Usage

To get started using pyblish-blender, run setup() at startup of your application.

# 1. Register your favourite GUI
import pyblish.api
pyblish.api.register_gui("pyblish_qml")

# 2. Set-up Pyblish for blender
import pyblish_blender
pyblish_blender.setup()

Documentation

• Under the hood
• Manually show GUI
• No menu-item
• Teardown pyblish-blender
• No GUI

Under the hood

The setup() command will:

1. Register blender as as a "host" to Pyblish, allowing plug-ins to be filtered accordingly.
2. Append a new menu item, "Publish" to your File-menu
3. Register a minimal set of plug-ins that are common across all integrations.

No menu-item

Should you not want a menu-item, pass menu=False.

import pyblish_blender
pyblish_blender.setup(menu=False)

Manually show GUI

The menu-button is set to run show(), which you may also manually call yourself, such as from a button.

import pyblish_blender
pyblish_blender.show()

Teardown pyblish-blender

To get rid of the menu, and completely remove any trace of pyblish-blender from your blender session, run teardown().

import pyblish_blender
pyblish_blender.teardown()

This will do the opposite of setup() and clean things up for you.

No GUI

In the event that no GUI is registered upon running setup(), the button will provide the user with this information on how they can get up and running on their own.

This is not implemented yet.

TODO

Turn pyblish-blender into a proper Blender addon.