Table Of Contents

Next topic

About

This Page

Stalker Documentation

About

Stalker is a Production Asset Management (ProdAM) System designed specifically for Animation and VFX Studios and licensed under BSD License.

Features:
  • Platform independent
  • Flexible design
  • Designed for animation and vfx studios
  • Default installation handles nearly all the asset management needs of an animation and vfx studio
  • Customisable with configuration scripts
  • Customisable object model (Stalker Object Model - SOM)
  • Integrated messaging system
  • Integrated production planing and tracking tools
  • PySide user interfaces
  • 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
  • SQLAlchemy
  • Jinja2
  • Beaker
  • PySide
  • Pyramid

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

Summary

stalker.db Database module of Stalker.
stalker.db.engine
stalker.db.metadata A collection of Tables and their associated schema constructs.
stalker.db.query
stalker.db.session
stalker.db.setup Utillty function that helps to connect the system to the given database.
stalker.core.errors Errors for the system.
stalker.core.errors.CircularDependencyError Raised when there is cirular dependencies within Tasks
stalker.core.errors.LoginError Raised when the login information is not correct or not correlate with the data in the database.
stalker.core.errors.DBError Raised when there is no database and a database related action has been placed.
stalker.core.models.ProjectMixin Gives the ability to connect to a Project to the mixed in object.
stalker.core.models.ReferenceMixin Adds reference capabilities to the mixed in class.
stalker.core.models.ScheduleMixin Adds schedule info to the mixed in class.
stalker.core.models.StatusMixin Adds statusabilities to the object.
stalker.core.models
stalker.core.models.Asset The Asset class is the whole idea behind Stalker.
stalker.core.models.Booking Holds information about the time spend on a specific task by a specific user.
stalker.core.models.Department The departments that forms the studio itself.
stalker.core.models.FilenameTemplate Holds templates for filename conventions.
stalker.core.models.Entity Another base data class that adds tags and notes to the attributes list.
stalker.core.models.ImageFormat Common image formats for the Projects.
stalker.core.models.Link Holds data about external links.
stalker.core.models.Message The base of the messaging system in Stalker
stalker.core.models.Note Notes for any of the SOM objects.
stalker.core.models.PermissionGroup Manages permission in the system.
stalker.core.models.Project All the information about a Project in Stalker is hold in this class.
stalker.core.models.Repository Manages fileserver/repository related data.
stalker.core.models.Review User reviews and comments about other entities.
stalker.core.models.Sequence Stores data about Sequences.
stalker.core.models.Shot Manages Shot related data.
stalker.core.models.SimpleEntity The base class of all the others
stalker.core.models.Status Defins object statutes.
stalker.core.models.StatusList Type specific list of Status instances.
stalker.core.models.Structure Holds data about how the physical files are arranged in the Repository.
stalker.core.models.Tag Use it to create tags for any object available in SOM.
stalker.core.models.Task Manages Task related data.
stalker.core.models.TaskableEntity Gives the abilitiy to connect to a list of Tasks to the mixed in object.
stalker.core.models.Type Everything can have a type.
stalker.core.models.User The user class is designed to hold data about a User in the system.
stalker.core.models.Version The connection to the filesystem.
stalker.ext.auth This is the authentication system of Stalker. Uses Beaker for the session
stalker.ext.auth.authenticate Authenticates the given username and password, returns a
stalker.ext.auth.check_password Checks the given raw password.
stalker.ext.auth.create_session Creates the beaker.session object.
stalker.ext.auth.login Persists the user_id in a session.
stalker.ext.auth.login_required a decorator that implements login functionality to any function or
stalker.ext.auth.logout removes the current session
stalker.ext.auth.permission_required a decorator that implements permission checking to any function or
stalker.ext.auth.set_password Returns an encrypted version of the given password.
stalker.utils.path_to_exec This is a utiliy function which converts full class or function paths

Indices and tables