=============
wapi.tracking
=============

Use this module to interact with the wizard asset tracking.

.. py:function:: wapi.tracking.get_task_assignment(stage)

   Return the current user assignment of the stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :return: The assigned user name
   :rtype: str

.. py:function:: wapi.tracking.get_task_state(stage)

   Return the current state of the stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :return: The state
   :rtype: str

.. py:function:: wapi.tracking.get_task_work_time(stage)

   Return the current work time elapsed on the stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :return: The work time in seconds
   :rtype: int

.. py:function:: wapi.tracking.get_task_estimated_time(stage)

   Return the current estimated time for the stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :return: The estimated time in seconds
   :rtype: int

.. py:function:: wapi.tracking.assign_task(stage, user)

   Assign the given user to the given stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :param user: The user name as string
   :type user: str
   :return: None
   :rtype: None

.. py:function:: wapi.tracking.set_task_state(stage, state)

   Assign the given state ( todo, wip, error, done ) to the given stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :param state: The state as string ( todo, wip, error, done )
   :type state: str
   :return: None
   :rtype: None

.. py:function:: wapi.tracking.estimate_task_time(stage, time)

   Assign the given estimation to the given stage

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :param time: The time in seconds
   :type state: int
   :return: None
   :rtype: None

.. py:function:: wapi.tracking.add_task_comment(stage, comment)

   Add a comment ot the given stage.

   :param stage: The stage as string ( example: "assets/characters/Joe/modeling" ) or int
   :type stage: str or int
   :param comment: The comment as string
   :type state: str
   :return: None
   :rtype: None