pytest_gee
==========

.. py:module:: pytest_gee

.. autoapi-nested-parse::

   The init file of the package.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pytest_gee/dictionary_regression/index
   /autoapi/pytest_gee/feature_collection_regression/index
   /autoapi/pytest_gee/image_regression/index
   /autoapi/pytest_gee/list_regression/index
   /autoapi/pytest_gee/plugin/index
   /autoapi/pytest_gee/utils/index


Attributes
----------

.. autoapisummary::

   pytest_gee.__author__
   pytest_gee.__email__
   pytest_gee.__version__


Functions
---------

.. autoapisummary::

   pytest_gee.init_ee_from_service_account
   pytest_gee.init_ee_from_token
   pytest_gee.wait


Package Contents
----------------

.. py:function:: init_ee_from_service_account()

   Initialize earth engine according using a service account.

   The environment used to run the tests need to have a EARTHENGINE_SERVICE_ACCOUNT variable.
   The content of this variable must be the copy of a personal credential file that you can generate from the google cloud console.

   .. note:: As all init method of ``pytest-gee``, this method will fallback to a regular ``ee.Initialize`` using the ``EARTHENGINE_PROJECT`` environment variable.


.. py:function:: init_ee_from_token()

   Initialize earth engine according using a token.

   THe environment used to run the tests need to have a EARTHENGINE_TOKEN variable.
   The content of this variable must be the copy of a personal credential file that you can find on your local computer if you already run the earth engine command line tool. See the usage question for a github action example.

   - Windows: ``C:\Users\USERNAME\\.config\\earthengine\\credentials``
   - Linux: ``/home/USERNAME/.config/earthengine/credentials``
   - MacOS: ``/Users/USERNAME/.config/earthengine/credentials``

   .. note:: As all init method of pytest-gee, this method will fallback to a regular ``ee.Initialize()`` if the environment variable is not found e.g. on your local computer.


.. py:function:: wait(task, timeout = 5 * 60)

   Wait until the selected process is finished or we reached timeout value.

   :param task: name of the running task or the Task object itself.
   :param timeout: timeout in seconds. if set to 0 the parameter is ignored. default to 5 minutes.

   :returns: the final state of the task


.. py:data:: __author__
   :value: 'Pierrick Rambaud'


.. py:data:: __email__
   :value: 'pierrick.rambaud49@gmail.com'


.. py:data:: __version__
   :value: '0.8.1'