owmeta_movement.zenodo module

class owmeta_movement.zenodo.ZenodoFileDataSource(*args, no_type_decl=False, **kwargs)

Bases: owmeta_core.data_trans.local_file_ds.LocalFileDataSource

A LocalFileDataSource that gets its data from Zenodo.

Mostly these come from the OpenWorm Movement Database community. There are differences between how different zenodo entries in this community package their data, so sub-classes should handle the details

https://zenodo.org/communities/open-worm-movement-database/?page=1&size=20

Parameters

commit_opCommitOp, optional

The operation to use for commiting the file changes. The default is COPY

zenodo_base_url

“zenodo_base_url”, a DatatypeProperty: Base Zenodo URL. Should use the well-known site URL if this property is unavailable

zenodo_file_name

“zenodo_file_name”, a DatatypeProperty: Name of a file in a Zenodo record in zenodo_id

zenodo_id

“zenodo_id”, a DatatypeProperty: Record ID from Zenodo

class owmeta_movement.zenodo.ZenodoRecord(*args, no_type_decl=False, **kwargs)

Bases: owmeta.document.BaseDocument

Represents a Zenodo record

property zenodo_id

Record ID from Zenodo

class owmeta_movement.zenodo.ZenodoRecordDirLoader(base_directory=None, session_provider=None, **kwargs)

Bases: owmeta_core.datasource_loader.DataSourceDirLoader

Provides files by downloading them from Zonodo.

Parameters

base_directorystr, optional

Path to a directory where files will be saved when requested. An attempt will be made to create the directory if it does not already exist. The files created in this directory may be reused by other instances of the same version of this class.

session_providercallable(), optional

Should return a requests.Session for the sake of making requests to Zenodo. By default, will use a new session for every request

owmeta_movement.zenodo.list_record_files(zenodo_id, session=None, zenodo_base_url=None)

List files in a Zenodo record

Parameters

zenodo_idint

Zenodo record ID for which files should be listed

sessionrequests.Session, optional

The session to use for requests to Zenodo. Creates a default requests.Session if not provided.

zenodo_base_urlstr, optional

The base URL for zenodo. Uses the common Zenodo URL if not provided

Yields

str

File names of records