api.sg¶
- vfxClientToolkit.api.sg.createDeliveryEntity(title, addressedTo, deliveryMethod, sg)[source]¶
Creates delivery entitiy in Shotgun.
- Args:
param1 (str): Delivery title. param2 (str):shotgun.Shotgun): Addressed to. param3 (str): Delivery method. param4 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
dict: Shotgun dictionary with entity info.
- vfxClientToolkit.api.sg.createPlaylist(name, versions)[source]¶
Creates playlist and adds provided versions to newly created list.
- Args:
param1 (str): Name of playlist (note: this should have the date provided in the following notation YYYYMMDD). param2 (list): List of vfxClientToolkit.api.entities.Version objects.
- Returns:
vfxClientToolkit.api.entities.Playlist: Newly created playlist object.
- vfxClientToolkit.api.sg.getAllDeliveries(sg)[source]¶
Returns all delivery entities in Shotgun.
- Args:
param1 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
dict: Shotgun dictionary with entity info.
- vfxClientToolkit.api.sg.getFields(entityName, sg)[source]¶
Returns list of entity attributes based on the provided entity type.
- Args:
param1 (str): Entity name. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
list: List of entity attributes.
- vfxClientToolkit.api.sg.getPlate(plateName, sg)[source]¶
Collects plate from Shotgun.
- Args:
param1 (str): Plate name. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
dict: Shotgun dictionary with entity info.
- vfxClientToolkit.api.sg.getPlaylists(sg)[source]¶
Returns all playlists based on the show specified in the configuration file(s).
- Args:
param1 (shotgun_api3.Shotgun): Shotgun DB Object.
- Returns:
list: List of dictionaries with Shotgun entity information.
- vfxClientToolkit.api.sg.getProject()[source]¶
Returns Shotgun dictionary entity based on defined project in configuration file.
- Returns:
dict: Shotgun entity information.
- vfxClientToolkit.api.sg.getSequence(sequenceName)[source]¶
Returns sequence object based upon specified name.
- Args:
param1 (str): Name of sequence.
- Returns:
vfxClientToolkit.api.entities.Sequence: Sequence object that matches provided name.
- vfxClientToolkit.api.sg.getSequences()[source]¶
Collects and returns all sequences from the configured Shotgun projet.
- Returns:
list: List of vfxClientToolkit.api.entities.Sequence objects.
- vfxClientToolkit.api.sg.getShot(shotName, sg)[source]¶
Collects and returns vfxClientToolkit.api.entities.Shot object.
- Args:
param1 (str): Name of shot. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
vfxClientToolkit.api.entities.Shot: Shot object.
- vfxClientToolkit.api.sg.getShotgunHandle()[source]¶
Returns shotgun_api3.Shotgun object using the API key from the configuration files.
- Returns:
shotgun_api3.shotgun.Shotgun: Configured Shotgun object.
- vfxClientToolkit.api.sg.getShotsByAttr(attrs, sg)[source]¶
Returns list of vfxClientToolkit.api.entities.Version objects that match the attribute filter provided.
- Args:
param1 (list): Filter attribute. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
list: Version objects in list that match filter criteria.
- vfxClientToolkit.api.sg.getShotsBySequence(sequenceCode)[source]¶
Collects and returns list of vfxClientToolkit.api.entities.Shot objects that below to provided sequence name.
- Args:
param1 (str): Name of sequence.
- Returns:
list: List of Shot entities.
- vfxClientToolkit.api.sg.getVendors()[source]¶
Returns all delivery entities in Shotgun.
- Args:
param1 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
dict: Shotgun dictionary with entity info.
- vfxClientToolkit.api.sg.getVersion(name, sg)[source]¶
Collects and returns vfxClientToolkit.api.entities.Version object.
- Args:
param1 (str): Name of version. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
vfxClientToolkit.api.entities.Version: Version object.
- vfxClientToolkit.api.sg.getVersionsByAttr(attrs, sg)[source]¶
Returns list of vfxClientToolkit.api.entities.Version objects that match the attribute filter provided.
- Args:
param1 (list): Filter attribute. param2 (shotgun_api3.shotgun.Shotgun): Shotgun handle.
- Returns:
list: Version objects in list that match filter criteria.