===========
wapi.launch
===========

Use this module to interact with the softwares process launched by wizard.

----------------
Launch functions
----------------

.. py:function:: wapi.launch.work_env(work_env)

   Launch a work environment ( example : seq_0001/sh_0001/animation/main/maya ).

   :param work_env: The work environment as string ( example : "seq_0001/sh_0001/animation/main/maya" ) or int
   :type work_env: str or int
   :return: None
   :rtype: None

.. py:function:: wapi.launch.work_version(work_version)

   Launch a work version ( example : seq_0001/sh_0001/animation/main/maya/0004 ).

   :param work_version: The work version as string ( example : "seq_0001/sh_0001/animation/main/maya/0004" ) or int
   :type work_version: str or int
   :return: None
   :rtype: None

.. py:function:: wapi.launch.kill_work_env(work_env)

   Terminate the given work environment if running ( example : seq_0001/sh_0001/animation/main/maya ).

   :param work_env: The work environment as string ( example : "seq_0001/sh_0001/animation/main/maya" ) or int
   :type work_env: str or int
   :return: None
   :rtype: None

.. py:function:: wapi.launch.kill_all()

   Terminate all the running work environments

   :return: None
   :rtype: None

.. py:function:: wapi.launch.get_running_work_envs()

   Return a list of the running work environment as a list of strings.

   :return: A list of the running work environments
   :rtype: list[str]

--------------
Lock functions
--------------

.. py:function:: wapi.launch.lock_work_env(work_env)

   Lock the given work environment ( example : seq_0001/sh_0001/animation/main/maya ).

   :param work_env: The work environment as string ( example : "seq_0001/sh_0001/animation/main/maya" ) or int
   :type work_env: str or int
   :return: None
   :rtype: None

.. py:function:: wapi.launch.unlock_work_env(work_env)

   Unlock the given work environment ( example : seq_0001/sh_0001/animation/main/maya ).

   :param work_env: The work environment as string ( example : "seq_0001/sh_0001/animation/main/maya" ) or int
   :type work_env: str or int
   :return: None
   :rtype: None

.. py:function:: wapi.launch.unlock_all(work_env)

   Unlock all the work environments locked by the current user.

   :return: None
   :rtype: None