API
Search…
Plug-in System
Learn about how things happen in Pyblish.

Introduction

There are three ways in which a plug-in is associated with a particular set of data.
  1. 1.
    By availability
  2. 2.
    By host
  3. 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.
1
class MyPlugin(...):
2
hosts = ["maya"]
Copied!
If the host matches, a plug-in is put to the final test; it's supported families.
1
class MyPlugin(...):
2
families = ["myFamily"]
Copied!
See also

Data

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)
Example
1
import pyblish.util
2
context = pyblish.util.collect()
3
print context.data["currentFile"]
Copied!
Last modified 1yr ago
Copy link