Tale of Three APIs
In Pyblish, there are three APIs that are of interest to you while developing plug-ins.
The Pyblish library itself carries an interface that is exposed to plug-ins. This is the interface you can use from within your plug-ins during development and includes things such as methods on each corresponding superclass, such as commit, to helper functions exposed globally, such as format_filename.
Conversely, each plug-in exposes certain attributes to the library. These are mainly attributes for identifying the plug-in, such as which families it supports and it's main processing method.
Finally, for plug-ins to coordinate with each other, they may pass data from one to another. It does this via the data member. Each stage, selection, validation, extraction and conform, may pass data from one to the next. One common example is for extraction to pass its output-path, called "commit_dir", on to conform that can then use this path to copy the files from its temporary location into its final destination.
Other data includes switches within the instance itself. For example, a Review family may include options for output resolution in pixels, or format such as whether to write a Quicktime or a plain png sequence.
This wiki is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Language, software and platform agnostic, feature film-strength quality assurance for content.
Table of contents
Developer Resources
More
Community