================
EnvironmentGroup
================

.. py:class:: EnvironmentGroup


   .. py:method:: id
      :property:

      The id of the group.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the group.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: list_environments()

      List the environments of this group.


      :returns: The list of environments in the group.
      :rtype: list(Environment)


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

      Delete a environment group

      .. note::
         By default, only empty groups can be deleted (:py:obj:`NotEmptyError` is raised otherwise), use ``force`` to force deletion of non empty groups.

      :param force: Force the deletion of the group even if it contains environments.
      :type force: bool


      :raises NotEmptyError: If ``force`` is :py:obj:`False` and the group contains environments.
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: create_local_environment(name, product_id)

      Create a new local environment.

      :param name: The name of the new local environment.
      :type name: str
      :param product_id: The id of the active product.
      :type product_id: str

      :returns: The newly created local environment.
      :rtype: Environment

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: import_from_encoded_data(data)

      Import a hdri.

      :param data: Encoded hdri image data.
      :type data: bytes

      :returns: The created environment.
      :rtype: Environment

      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.