tik_manager4.management.shotgrid.main

Main module for the Shotgrid integration.

Attributes

LOG
STATUS_LISTS
external_folder
shotgun_folder

Classes

ProductionPlatform

Main class for the Shotgrid integration.

Module Contents

class ProductionPlatform(tik_main_obj)

Bases: tik_manager4.management.management_core.ManagementCore

Main class for the Shotgrid integration.

authenticate()

Connect to Shotgrid.

create_from_project(project_root, shotgrid_project_id, set_project=True)

Create a tik_manager4 project from the existing Shotgrid project.

force_sync()

Force sync the project with Shotgrid.

get_all_assets(project_id)

Get all the assets from Shotgrid.

Args:

project_id (int): The ID of the project.

Returns:

List[Dict[str, Any]]: A list of assets.

get_all_shots(project_id)

Get all the shots from Shotgrid.

Args:

project_id (int): The ID of the project.

Returns:

List[Dict[str, Any]]: A list of shots.

get_available_status_lists(force=False)

Get the status codes from Shotgrid.

get_entity_url(entity_type, entity_id)

Constructs the URL for a specific entity in ShotGrid.

Args:

entity_type (str): The type of the entity. Asset or Shot. entity_id (int): The ID of the entity.

Returns:

str: The URL of the entity.

get_projects(archived: bool = False, is_template: bool = False, is_demo: bool = False) → list

Get all the projects from Shotgrid.

static get_settings_ui()

Return the settings UI for the Shotgrid platform.

get_user_id(email)

Get a user from Shotgrid by email.

logout()

Log out from Shotgrid.

publish_version(entity_type=None, entity_id=None, task_id=None, name=None, path=None, project_id=None, status=None, description='', thumbnail=None, preview=None, email=None, **kwargs)

Publish a version to Shotgrid.

Args:

entity_type (str): The type of the entity. Asset or Shot. entity_id (int): The ID of the entity. task_id (int): The ID of the task. name (str): The name of the version. path (str): Project relative path to the file. project_id (int): The ID of the project. status (str, optional): The status of the task that will be turned into.

Defaults to None.

description (str, optional): The description of the version. Defaults to “”. thumbnail (str, optional): The path to the thumbnail file. Defaults to None. preview (str, optional): The path to the preview file. Defaults to None. email (str, optional): The email of the user. Defaults to None.

Returns:

dict: The published version data.

request_tasks(entity_id, entity_type, step=None, project_id=None)

Get all the tasks from a Shotgrid entity ID.

Example output:

[

{‘type’: ‘Task’, ‘id’: 5981, ‘content’: ‘Cloth’}, {‘type’: ‘Task’, ‘id’: 5983, ‘content’: ‘Rig’}, {‘type’: ‘Task’, ‘id’: 5984, ‘content’: ‘Muscle’}

]

Args:

entity_id (int): The ID of the entity. entity_type (str): The type of the entity. Asset or Shot. step (str, optional): The step of the task. Defaults to None. project_id (int, optional): The ID of the project. Defaults to None.

sync_project()

Sync the project with Shotgrid.

property host

lock_subproject_creation = True

lock_task_creation = True

metadata_pairing

name = 'shotgrid'

nice_name = 'Autodesk Flow Production'

LOG

STATUS_LISTS = []

external_folder

shotgun_folder