Stalker Documentation

About

Stalker is an Open Source Production Asset Management (ProdAM) System 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.
• It is a Pyramid Web Application and also SOM (Stalker Object Model) API can be used as a Python library.
• 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, XSI, Vue, Blender etc. and any application that has a Python API.
• Can work as a stand-alone application.

Stalker is build over these other OpenSource projects:

• Python
• Pyramid
• SQLAlchemy and Alembic
• Jinja2
• TaskJuggler

Source

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

hg clone https://stalker.googlecode.com/hg/ stalker

Table of Contents

• About
  • Source
• Installation
  • How to Install Stalker
  • Install Python
  • Install Stalker
    • Installing setuptools with ez_setup:
    • Installing Stalker (All OSes):
  • Checking the installation of Stalker
  • For developers
  • Installing a Database
• API Tutorial
  • Introduction
  • Part I - Basics
  • Part II/A - Creating Simple Data
  • Part II/B - Querying, Updating and Deleting Data
  • Part III - Pipeline
  • Part IV - Task & Resource Management
  • Part V - Asset Management
  • Part VI - Collaboration (coming)
  • Part VII - Session Management (coming)
  • Part VIII - Extending SOM (coming)
• Design
  • Introduction
  • Concepts
    • Stalker Object Model (SOM)
  • Inheritance Diagram
    • Features and Requirements
  • How To Customize Stalker
  • How To Extend SOM
• How To Contribute
  • Development Style
  • Testing
  • Coding Style
  • SCM - Mercurial (HG)
  • Adding Changes
• Stalker Development Roadmap
  • Roadmap Based on Versions
    • 0.1.0:
    • 0.2.0:
• Stalker Changes
  • 0.2.0.b7
  • 0.2.0.b6
  • 0.2.0.b5
  • 0.2.0.b4
  • 0.2.0.b3
  • 0.2.0.b2
  • 0.2.0.b1
  • 0.2.0.a10
  • 0.2.0.a9
  • 0.2.0.a8
  • 0.2.0.a7
  • 0.2.0.a6
  • 0.2.0.a5
  • 0.2.0.a4
  • 0.2.0.a3
  • 0.2.0.a2
  • 0.2.0.a1
• TODO
• DONE:

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
stalker.exceptions.LoginError	Raised when the login information is not correct or not correlate with
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.RootFactory	The main purpose of having a root factory is to generate the objects used as the context by the request.
stalker.models.auth.User	The user class is designed to hold data about a User in the system.
stalker.models.department.Department	The departments that forms the studio itself.
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.env.EnvironmentBase	Connects the environment (the host program) to Stalker.
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.ProjectMixin	Gives the ability to connect to 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.repository.Repository	Manages fileserver/repository related data.
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	Holds data about how the physical files are arranged in the Repository.
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.TimeLog	Holds information about the uninterrupted time spend on a specific
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 in Stalker.
stalker.models.ticket.TicketLog	A class to hold 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:~stalker.models.task.Task

Indices and tables

• Index
• Module Index
• Search Page