pyblish-by-example: A CSS repository from Pyblish

Welcome to the Pyblish by Example tutorial.

You will learn

The basics of publishing in the production of film and games
The fundamentals of Pyblish and it's API
How to validate content
How to guarantee valid content on export
How to properly position and name content according to convention
How to visualise the results of one or more publishes
Developer and Artist communication through the UI

Introduction

Pyblish is an open source, cross-platform framework for test-driven content creation.

Pyblish by Example is a hands-on introduction to Pyblish using short example programs written like a book - to be read from top to bottom.

What is Publishing?

Installation

If you haven't already, go ahead and install Pyblish.

$ pip install pyblish-base

Any problems, have a look at the extended installation guide.

How to use this guide

Start by confirming to yourself that you are indeed using version 1.4+ of Pyblish.

>>> import pyblish
>>> pyblish.__version__
'1.4.3'

If not, see the top-left corner of this page for a dropdown of your version.

As you read through this guide it is recommended that you use the scripting API, accessible via pyblish.util.

from pyblish import util
util.publish()

Reporting issues

Should you happen to find errors or would like to contribute material to this guide, you can:

Click on the + button to the right of each paragraph to add a comment
Register on GitBook to edit this book directly.
Fork the GitHub repository and submit a pull-request with your changes.

Content

Have a look to the left for a table of contents, and below for related topics in the forums.

Note: The below content was written at various versions of Pyblish and may not include current best practices, but all remain forwards compatible with version 1.4.

For example, .set_data("key", "value") has been superseded by .data["key"] = "value" but will still work with newer plug-ins.

Intermediate

Advanced

Changelog