tik_manager4.management.kitsu.main

Main module for the Kitsu integration.

Attributes

`CRYPTOR`
`LOG`
`external_folder`
`kitsu_folder`

Classes

`ProductionPlatform`	Main class for Kitsu integration.
`SyncBlock`	Class to store and execute sync blocks.

Module Contents

class ProductionPlatform(tik_main_obj)

Bases: tik_manager4.management.management_core.ManagementCore

Main class for Kitsu integration.

authenticate(): Authenticate the user.

create_from_project(project_root, kitsu_project_id, set_project=True): Create a tik manager project from a kitsu project.

force_sync(project_id=None)

Force the sync of the project.

Args:

project_id (str, optional): The project ID to sync. If not provided,: attempts to get it from the project database. Defaults to None.

Raises:

Exception: If the project is not linked to a Shotgrid project.

get_all_assets(project_id): Get all the assets from a project.

get_all_episodes(project_id): Get all the episodes from a project.

get_all_sequences(project_id): Get all the sequences from a project.

get_all_shots(project_id): Get all the shots from a project.

get_available_status_lists(force=False): Return the available status lists.

get_entity_url(entity_type, entity_id): Return the URL of the entity.

get_projects(archived: bool = False, is_template: bool = False, is_demo: bool = False) → list: Get all the projects from Kitsu.

static get_settings_ui(): Return the settings UI for the Shotgrid platform.

logout(): Logout the user.

publish_version(task_id, status=None, description='', thumbnail=None, preview: str = None, publish_version: int = None, **kwargs)

Publish a version to Kitsu using gazu.

Args:

task_id (str): The ID of the task. status (str, optional): The status that the task will be turned to.

If not specified, current status stays.

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. publish_version (int, optional): The version number to publish.

Defaults to None.

Returns:

dict: The published version data.

request_tasks(entity_id, entity_type, step=None, project_id=None): Request the tasks from the Kitsu server.

sync_project(): Sync the project with the Kitsu project.

property host

property host_api

lock_subproject_creation = True

lock_task_creation = True

metadata_pairing

name = 'kitsu'

nice_name = 'Kitsu'

class SyncBlock(gazu_instance, tik_main, project)

Class to store and execute sync blocks.

execute(): Execute the sync block.

property categories
The categories that will be used when creating a new tik task.: Can be asset or shot categories.

property event_type

property kitsu_data
The data represented as in Kitsu.: This can be a kitsu-shot, kitsu-asset or kitsu-task.

metadata_pairing

property subproject
The subproject that the sync block is associated with.: Usually the “Assets” or “Shots” subproject.

CRYPTOR

LOG

external_folder

kitsu_folder