Bases: stalker.core.models.entity.Entity
A structure object is the place to hold data about how the physical files are arranged in the Repository.
A structure has these parameters: :param project_template: it is a string holding several lines of text
showing the folder structure of the project. Whenever a project is created, folders are created by looking at this folder template.
The template string can have Jinja2 directives. These variables are given to the template engine:
- project: holds the current project object using this structure, so you can use {{project.code}} or {{project.sequences}} kind of variables in the Jinja2 template
Parameters: |
---|
This templates are used in creation of Project folder structure and also while interacting with the assets and references in the current Project. You can create one project structure for Commmercials and another project structure for Movies and another one for Print projects etc. and can reuse them with new projects.
Methods
__init__(**kwargs[, project_template, ...]) |
Attributes
asset_templates | A list of |
created_by | gets and sets the User object who has created this |
date_created | gets and sets the datetime.datetime object which shows when |
date_updated | gets and sets the datetime.datetime object which shows when |
description | the description of the entity |
name | the name of the entity |
nice_name | this is the nice name of the SimpleEntity, it is a string which is a little bit more formatted than the name attribute |
project_template | A string which shows the folder structure of the current project. |
reference_templates | A list of |
tags | a list of Tag objects which shows the related tags to the |
updated_by | gets and sets the User object who has updated this |
A list of TypeTemplate objects which gives information about the Asset Version file placements
gets and sets the User object who has created this AuditEntity
gets and sets the datetime.datetime object which shows when this object has been created
gets and sets the datetime.datetime object which shows when this object has been updated
the description of the entity
the name of the entity
this is the nice name of the SimpleEntity, it is a string which is a little bit more formatted than the name attribute
A string which shows the folder structure of the current project. It can have Jinja2 directives. See the documentation of Structure object for more information
A list of TypeTemplate objects which gives information about the placement of references to entities
a list of Tag objects which shows the related tags to the entity
gets and sets the User object who has updated this AuditEntity