tik_manager4.management.kitsu.main
==================================

.. py:module:: tik_manager4.management.kitsu.main

.. autoapi-nested-parse::

   Main module for the Kitsu integration.



Attributes
----------

.. autoapisummary::

   tik_manager4.management.kitsu.main.CRYPTOR
   tik_manager4.management.kitsu.main.LOG
   tik_manager4.management.kitsu.main.external_folder
   tik_manager4.management.kitsu.main.kitsu_folder


Classes
-------

.. autoapisummary::

   tik_manager4.management.kitsu.main.ProductionPlatform
   tik_manager4.management.kitsu.main.SyncBlock


Module Contents
---------------

.. py:class:: ProductionPlatform(tik_main_obj)

   Bases: :py:obj:`tik_manager4.management.management_core.ManagementCore`


   Main class for Kitsu integration.


   .. py:method:: authenticate()

      Authenticate the user.



   .. py:method:: create_from_project(project_root, kitsu_project_id, set_project=True)

      Create a tik manager project from a kitsu project.



   .. py:method:: 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.



   .. py:method:: get_all_assets(project_id)

      Get all the assets from a project.



   .. py:method:: get_all_episodes(project_id)

      Get all the episodes from a project.



   .. py:method:: get_all_sequences(project_id)

      Get all the sequences from a project.



   .. py:method:: get_all_shots(project_id)

      Get all the shots from a project.



   .. py:method:: get_available_status_lists(force=False)

      Return the available status lists.



   .. py:method:: get_entity_url(entity_type, entity_id)

      Return the URL of the entity.



   .. py:method:: get_projects(archived: bool = False, is_template: bool = False, is_demo: bool = False) -> list

      Get all the projects from Kitsu.



   .. py:method:: get_settings_ui()
      :staticmethod:


      Return the settings UI for the Shotgrid platform.



   .. py:method:: logout()

      Logout the user.



   .. py:method:: 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.



   .. py:method:: request_tasks(entity_id, entity_type, step=None, project_id=None)

      Request the tasks from the Kitsu server.



   .. py:method:: sync_project()

      Sync the project with the Kitsu project.



   .. py:property:: host


   .. py:property:: host_api


   .. py:attribute:: lock_subproject_creation
      :value: True



   .. py:attribute:: lock_task_creation
      :value: True



   .. py:attribute:: metadata_pairing


   .. py:attribute:: name
      :value: 'kitsu'



   .. py:attribute:: nice_name
      :value: 'Kitsu'



.. py:class:: SyncBlock(gazu_instance, tik_main, project)

   Class to store and execute sync blocks.


   .. py:method:: execute()

      Execute the sync block.



   .. py:property:: categories
      The categories that will be used when creating a new tik task.

      Can be asset or shot categories.



   .. py:property:: event_type


   .. py:property:: kitsu_data
      The data represented as in Kitsu.

      This can be a kitsu-shot, kitsu-asset or kitsu-task.



   .. py:attribute:: metadata_pairing


   .. py:property:: subproject
      The subproject that the sync block is associated with.

      Usually the "Assets" or "Shots" subproject.



.. py:data:: CRYPTOR

.. py:data:: LOG

.. py:data:: external_folder

.. py:data:: kitsu_folder