Pyblish integration for SideFx Houdini 8-15.
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.
pyblish-houdini depends on pyblish-base and is available via PyPI.
$ pip install pyblish-houdini
To get started using pyblish-houdini, run
setup() at startup of your application.
# 1. Register your favourite GUI import pyblish.api pyblish.api.register_gui("pyblish_lite") # 2. Set-up Pyblish for Houdini import pyblish_houdini pyblish_houdini.setup()
In order to have Pyblish become a permanent member of each Houdini session, you can add the supplied
houdini_path/ folder to your
HOUDINI_PATH environment variable.
Take care however, for this variable has an unexpected quirk on Windows platforms.
$ set "HOUDINI_PATH=C:\pythonpath\pyblish_houdini\houdini_path;&"
& sign, and the fact that the entire expression is wrapped in quotation marks.
If you use batch script files on Windows to launch Houdini, you'll need to escape the "&" character with "^&".
With this variable set, you should find a new File-menu item.
NOTE: If you use "HOUDINI_PATH" in houdini.env, make sure you setup the path here instead or inherit the environment with "$HOUDINI_PATH"
Under the hood
setup() command will:
- Register Houdini related "hosts", allowing plug-ins to be filtered accordingly.
- Register a minimal set of plug-ins that are common across all integrations.
Manually show GUI
The menu-button is set to run
show(), which you may also manually call yourself, such as from a shelf-button.
import pyblish_houdini pyblish_houdini.show()
To get rid of the menu, and completely remove any trace of pyblish-houdini from your Houdini session, run
import pyblish_houdini pyblish_houdini.teardown()
This will do the opposite of
setup() and clean things up for you.
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.