API Overview

Foreword

First let me say that API is probably a little misleading since the helga package is mostly a collection of custom tools written in Python, which are independent of each other (like helga.nuke.reconstruction.renderReconstructVRay). But there might be modules in the future that are ment to be exclusively building blocks for programmers.

Organization

Our pipeline is split up into several kinds of packages that import from a logical hierarchy. We can add packages at any depth in the hierarchy at any time.

Category packages

Please note the packages named after contributors. Packages without a name are assumed to be completely written by me (Timm Wagener). If you want to contribute just ask and you will get your own category package.

Warning

Please never contribute outside of your own category package!

Work and Deploy

There are two Helga packages located under:

  • production/scripts/work:

    Here is where we work and edit our scripts. You are expected to always work here and copy your stuff over to deploy when ready. If you work and edit in deploy to save the copy step, you will sooner or later loose work, since i will often delete and recopy the whole helga package.

  • production/scripts/deploy:

    Here is where the DCCs use our scripts and their compilers do the byte compilation (create .pyc files)

This is basically source control for the poor man, but since the helga package was initially ment to be exclusively my own sandbox we have to deal with that inconvenience.