tik_manager4.management.shotgrid.main
=====================================

.. py:module:: tik_manager4.management.shotgrid.main

.. autoapi-nested-parse::

   Main module for the Shotgrid integration.



Attributes
----------

.. autoapisummary::

   tik_manager4.management.shotgrid.main.LOG
   tik_manager4.management.shotgrid.main.STATUS_LISTS
   tik_manager4.management.shotgrid.main.external_folder
   tik_manager4.management.shotgrid.main.shotgun_folder


Classes
-------

.. autoapisummary::

   tik_manager4.management.shotgrid.main.ProductionPlatform


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

.. py:class:: ProductionPlatform(tik_main_obj)

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


   Main class for the Shotgrid integration.


   .. py:method:: authenticate()

      Connect to Shotgrid.



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

      Create a tik_manager4 project from the existing Shotgrid project.



   .. py:method:: force_sync()

      Force sync the project with Shotgrid.



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



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



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

      Get the status codes from Shotgrid.



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



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

      Get all the projects from Shotgrid.



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


      Return the settings UI for the Shotgrid platform.



   .. py:method:: get_user_id(email)

      Get a user from Shotgrid by email.



   .. py:method:: logout()

      Log out from Shotgrid.



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



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



   .. py:method:: sync_project()

      Sync the project with Shotgrid.



   .. py:property:: host


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



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



   .. py:attribute:: metadata_pairing


   .. py:attribute:: name
      :value: 'shotgrid'



   .. py:attribute:: nice_name
      :value: 'Autodesk Flow Production'



.. py:data:: LOG

.. py:data:: STATUS_LISTS
   :value: []


.. py:data:: external_folder

.. py:data:: shotgun_folder