Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions alphabase/tools/data_downloader.py
Original file line number Diff line number Diff line change
Expand Up @@ -287,3 +287,52 @@ def _encode_url(self) -> str: # pragma: no cover
return f"{self._url}/download"

return self._url


class ZenodoDownloader(FileDownloader):
"""Class for downloading files from Zenodo links.

Example
-------

.. code-block:: python

downloader = ZenodoDownloader.from_record_data(
record_id="15002613",
file_name="report.parquet",
output_dir="/tmp/"
)
downloader.download()

"""

ZENODO_DOWNLOAD_URL = (
"https://zenodo.org/api/records/{record_id}/files/{file_name}/content"
)
"""Download URL for Zenodo records"""

def _encode_url(self) -> str:
"""Encode Zenodo sharing link as url for downloading files."""
return self._url

@classmethod
def from_record_data(
cls, record_id: str, file_name: str, output_dir: str
) -> "ZenodoDownloader":
"""Create Zenodo Downloader from record information.

Parameters
-----------
record_id
Record ID as displayed in zenodo url
e.g. 12345 in https://zenodo.org/records/12345.
file_name
File name to extract from record.
output_dir
Directory to save downloaded file to.

"""
zenodo_download_url = cls.ZENODO_DOWNLOAD_URL.format(
record_id=record_id, file_name=file_name
)
return cls(url=zenodo_download_url, output_dir=output_dir)
Loading