Bases: stalker.core.models.entity.Entity, stalker.core.models.mixin.ReferenceMixin, stalker.core.models.mixin.StatusMixin
All the information about a Project in Stalker is hold in this class.
Project is one of the main classes that will direct the others. A project in Stalker is a gathering point.
The date attributes like start_date and due_date can be managed with timezones. Follow the Python idioms shown in the help files of datetime
It is mixed with ReferenceMixin and StatusMixin to give reference and status abilities.
Parameters: |
|
---|
Methods
__init__(2, **kwargs[, start_date, ...]) |
Attributes
assets | the list of assets created in this project |
code | |
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 |
display_width | the target display width that this project is going to be |
due_date | The date that the project should be delivered, can be set to a datetime.timedelta and in this case it will be calculated as an offset from the start_date and converted to datetime.date again. |
fps | the fps of the project, it is a float value, any other types |
image_format | the image format of the current project. This value defines |
is_stereoscopic | True if the project is a stereoscopic project |
lead | the lead of the project, should be an instance of |
name | the name of the entity |
nice_name | this is the nice name of the SimpleEntity. It has the same |
notes | all the notes about this entity, it should be a list of Notes |
references | references are lists containing |
repository | the repository that this project should reside, should be an |
sequences | the sequences contained in this project, should be a list |
start_date | The date that this project should start. |
status | this is the property that sets and returns the status |
status_list | this is the property that sets and returns the status_list |
structure | The structure of the project. |
tags | a list of Tag objects which shows the related tags to the |
type | defines the type of the project, should be an instance of |
updated_by | gets and sets the User object who has updated this |
users | the users assigned to this project. Should be a list of |
this is the property that sets and returns the status_list attribute
this is the property that sets and returns the status attribute
the target display width that this project is going to be displayed on, meaningfull if this project is a stereoscopic project
The date that the project should be delivered, can be set to a datetime.timedelta and in this case it will be calculated as an offset from the start_date and converted to datetime.date again. Setting the start_date to a date passing the due_date will also set the due_date so the timedelta between them is preserved, default value is 10 days
the fps of the project, it is a float value, any other types will be converted to float. The default value is 25.0
the image format of the current project. This value defines the output image format of the project, should be an instance of ImageFormat, can not be skipped
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 has the same value with the name (contextually) but with a different format like, all the whitespaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lowercase.
There is also the code attribute which is simple the uppercase form of nice_name if it is not defined differently (i.e set to another value).
all the notes about this entity, it should be a list of Notes objects or an empty list, None is not accepted
a list of Tag objects which shows the related tags to the entity
gets and sets the User object who has updated this AuditEntity
the repository that this project should reside, should be an instance of Repository, can not be skipped
the sequences contained in this project, should be a list containing all of Sequence instances, when set to None it is converted to an empty list
The date that this project should start. Also effects the due_date in certain conditions, if the start_date is set to a time passing the due_date it will also offset the due_date to keep the time difference between the start_date and due_date. start_date should be an instance of datetime.date and the default value is datetime.date.today()
defines the type of the project, should be an instance of ProjectType