API
Search…
API
1.6
Introduction
Plug-in System
Data
Environment Variables
Ordering
pyblish.util
pyblish.cli
pyblish.api
Powered By GitBook
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.
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

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
import pyblish.util
context = pyblish.util.collect()
print context.data["currentFile"]
Previous
Introduction
Next
Data
Last modified 2yr ago
Copy link
On this page
Introduction
Data