Downloading Data
================

The connector provides a uniform ``download`` method on folders, exams, series
and datasets.

Download from a folder
-----------------------

.. code-block:: python

   from pathlib import Path

   folder = agora.get_folder(45)
   target = Path('/local/downloads')

   downloaded = folder.download(target, recursive=False)
   for f in downloaded:
       print(f)

Pass ``recursive=True`` to also download items in sub-folders:

.. code-block:: python

   downloaded = folder.download(target, recursive=True)

Download an exam
-----------------

.. code-block:: python

   exam       = agora.get_exam(42)
   downloaded = exam.download(Path('/local/downloads'))

Download a series
------------------

.. code-block:: python

   series     = agora.get_series(76)
   downloaded = series.download(Path('/local/downloads'))

Download a dataset
-------------------

.. code-block:: python

   dataset    = agora.get_dataset(158)
   downloaded = dataset.download(Path('/local/downloads'))

The returned list contains :class:`pathlib.Path` objects pointing to the
saved local files.