hueyyeng/konbini

おまえはもうショットいる。なに？！Opinionated wrapper for Autodesk ShotGrid Python API

konbini's Issues

Expand SgProject dataclass attributes

archived: bool = False
code: Optional[str] = None
sg_description: Optional[str] = None
sg_status: Optional[str] = None
sg_type: Optional[str] = None
start_date: Optional[str] = None  # Date uses YYYY-MM-DD format
end_date: Optional[str] = None
image: Optional[str] = None
duration: Optional[int] = None  # Number of days

Create helper function to retrieve valid status list

Pain point

TLDR: Status entity refers to the Global Status List and entities that link to it have their own "valid list".

Status entity is practically useless by itself because other SG entities that have relevant status field does not necessarily have valid values that refers to Status entity

Example

This differs by studios so the valid values varies. You can check the valid values by using sg.schema_field_read(ENTITY, status_field) where ENTITY is Project/Asset/Shot blah and status_field is the status field name which once again... varies between each SG entities. Go figure.

1. Project entity have sg_status and example valid values is ['Bidding', 'Active', 'Lost', 'Hold'].
2. Asset/Shot/Sequence uses sg_status_list and example valid generalised values is ['wtg', 'ip', 'fin']

Tackling this problem

Originally thought of syncing the list of Status entities into internal pipeline system but that is a dumb approach as the SG entities may not necessarily point to Status entity. Example from above, Project entity with sg_status.

For Asset/Shot/Sequence/etc, the valid statuses is configurable by performing the configure field on their respective Status column.

Having a helper function that returns the list of valid values should prevent devs from trying to set a status that is not valid for the particular SG entity.

Allow kwargs/arbitrary key value for CRUD wrapper functions

Expand _SgHumanUser dataclass attributes

email: str
firstname: str
lastname: str
login: str
file_access: bool
image: Optional[str]