Plug-in System

Learn about how things happen in Pyblish.


There are three ways in which a plug-in is associated with a particular set of data.

  1. By availability
  2. By host
  3. By family

Availability is determined by registering a given plug-in to Pyblish, for example by calling register_plugin_path(). Once a plug-in is made available, it must also match the currently running host.

class MyPlugin(...):
  hosts = ["maya"]

If the host matches, a plug-in is put to the final test; it's supported families.

class MyPlugin(...):
  families = ["myFamily"]

See also


These data members are included.

Data Description
currentFile Current working file
workspaceDir Higher-level directory of current file
user Currently logged on user
cwd Current working directory (of Python interpreter)


import pyblish.util
context = pyblish.util.collect()

results matching ""

    No results matching ""