Stalker Documentation

About

Stalker is an Open Source Production Asset Management (ProdAM) Library designed specifically for Animation and VFX Studios but can be used for any kind of projects. Stalker is licensed under LGPL v2.1.

Features:
  • Designed for animation and VFX Studios.
  • Platform independent.
  • Default installation handles nearly all the asset and project management needs of an animation and vfx studio.
  • Customizable with configuration scripts.
  • Customizable object model (Stalker Object Model - SOM).
  • Uses TaskJuggler as the project planing and tracking backend.
  • Can be used with any kind of databases supported by SQLAlchemy.
  • Can be connected to all the major 3d animation packages like Maya, Houdini, Nuke, Softimage, Vue, Blender etc. and any application that has a Python API.
  • Python 2.6+ and Python 3.0+ compatible.
Stalker is build over these other OpenSource projects:
  • Python
  • SQLAlchemy and Alembic
  • Jinja2
  • TaskJuggler

Stalker as a library has no graphical UI, it is a python library that gives you the ability to build your pipeline on top of it. There are other python packages like the Open Source Pyramid Web Application Stalker Pyramid and the Open Source pipeline library Anima which has PyQt/PySide UIs for applications like Maya, Nuke, Houdini, Eyeon Fusion, Photoshop etc.

Source

The latest development version is available in GitHub page of Stalker or can be directly cloned with the following command if you already have git installed:

git clone https://github.com/eoyilmaz/stalker.git

Table of Contents

Summary

stalker.db Database module of Stalker.
stalker.db.setup Utility function that helps to connect the system to the given database.
stalker.exceptions Errors for the system.
stalker.exceptions.CircularDependencyError Raised when there is circular dependencies within Tasks
stalker.exceptions.DBError Raised when there is no database and a database related action has been placed.
stalker.exceptions.LoginError Raised when the login information is not correct or not correlate with the data in the database.
stalker.exceptions.OverBookedError Raised when a resource is booked more than once for the same time period
stalker.exceptions.StatusError Raised when the status of an entity is not suitable for the desired
stalker.models
stalker.models.asset.Asset The Asset class is the whole idea behind Stalker.
stalker.models.auth.Group Creates groups for users to be used in authorization system.
stalker.models.auth.LocalSession A simple temporary session object which simple stores session data.
stalker.models.auth.Permission A class to hold permissions.
stalker.models.auth.User The user class is designed to hold data about a User in the system.
stalker.models.budget.Budget Manages project budgets
stalker.models.budget.BudgetEntry Manages budget entries in a budget
stalker.models.budget.Good Manages commercial items that is served by the Studio.
stalker.models.budget.PriceList Contains CommercialItems to create a list of items that is sold by the Studio.
stalker.models.department.Department The departments that forms the studio itself.
stalker.models.department.DepartmentUser The association object used in Department-to-User relation
stalker.models.client.Client The Client (e.g.
stalker.models.client.ClientUser The association object used in Client-to-User relation
stalker.models.entity.Entity Another base data class that adds tags and notes to the attributes list.
stalker.models.entity.SimpleEntity The base class of all the others
stalker.models.format.ImageFormat Common image formats for the Projects.
stalker.models.link.Link Holds data about external links.
stalker.models.message.Message The base of the messaging system in Stalker
stalker.models.mixins.ACLMixin A Mixin for adding ACLs to mixed in class.
stalker.models.mixins.CodeMixin Adds code info to the mixed in class.
stalker.models.mixins.DateRangeMixin Adds date range info to the mixed in class.
stalker.models.mixins.ProjectMixin Allows connecting a Project to the mixed in object.
stalker.models.mixins.ReferenceMixin Adds reference capabilities to the mixed in class.
stalker.models.mixins.ScheduleMixin Adds schedule info to the mixed in class.
stalker.models.mixins.StatusMixin Makes the mixed in object statusable.
stalker.models.mixins.TargetEntityTypeMixin Adds target_entity_type attribute to mixed in class.
stalker.models.mixins.WorkingHoursMixin Sets working hours for the mixed in class.
stalker.models.note.Note Notes for any of the SOM objects.
stalker.models.project.Project All the information about a Project in Stalker is hold in this class.
stalker.models.project.ProjectUser The association object used in User-to-Project relation
stalker.models.repository.Repository Manages fileserver/repository related data.
stalker.models.review.Review Manages the Task Review Workflow.
stalker.models.review.Daily Manages data related to Dailies.
stalker.models.review.DailyLink The association object used in Daily-to-Link relation
stalker.models.scene.Scene Stores data about Scenes.
stalker.models.schedulers.SchedulerBase This is the base class for schedulers.
stalker.models.schedulers.TaskJugglerScheduler This is the main scheduler for Stalker right now.
stalker.models.sequence.Sequence Stores data about Sequences.
stalker.models.shot.Shot Manages Shot related data.
stalker.models.status.Status Defines object statutes.
stalker.models.status.StatusList Type specific list of Status instances.
stalker.models.structure.Structure Defines folder structures for Projects.
stalker.models.studio.Studio Manage all the studio information at once.
stalker.models.studio.WorkingHours A helper class to manage Studio working hours.
stalker.models.tag.Tag Use it to create tags for any object available in SOM.
stalker.models.task.Task Manages Task related data.
stalker.models.task.TaskDependency The association object used in Task-to-Task dependency relation
stalker.models.task.TimeLog Holds information about the uninterrupted time spent on a specific Task by a specific User.
stalker.models.template.FilenameTemplate Holds templates for filename and path conventions.
stalker.models.ticket.Ticket Tickets are the way of reporting errors or asking for changes.
stalker.models.ticket.TicketLog Holds Ticket.Ticket.status change operations.
stalker.models.type.EntityType A simple class just to hold the registered class names in Stalker
stalker.models.type.Type Everything can have a type.
stalker.models.version.Version Holds information about the created versions (files) for a class:.Task
stalker.models.wiki.Page A simple Wiki page implementation.

Indices and tables

Table Of Contents

Next topic

About