facile_rs.utils.zenodo

Module Contents

Functions

create_zenodo_dataset

Create a dataset in Zenodo, using the personal token provided. If a Zenodo ID is provided as previous_version, a new version of this Zenodo record will be created.

prepare_zenodo_dataset

update_zenodo_dataset

Update a dataset’s metadata at the given Zenodo link.

upload_zenodo_assets

Upload assets to a Zenodo dataset.

delete_zenodo_dataset

Delete a draft record from Zenodo.

get_zenodo_dataset

Get a record from Zenodo.

Data

logger

API

logger = 'getLogger(...)'
create_zenodo_dataset(zenodo_url, zenodo_token, zenodo_dict, previous_version=None)

Create a dataset in Zenodo, using the personal token provided. If a Zenodo ID is provided as previous_version, a new version of this Zenodo record will be created.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • zenodo_token (str) – Zenodo personal token

  • zenodo_dict (dict) – Zenodo metadata dictionary, as returned by ZenodoMetadata.as_dict()

  • previous_version (str or None) – ID of the record to create a new version of, if applicable

Returns:

Zenodo dataset ID

Return type:

str

prepare_zenodo_dataset(zenodo_url, dataset_id, zenodo_token)

” Prepare a dataset for review in ZENODO.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • dataset_id – Zenodo dataset ID

  • zenodo_token – The Zenodo personal token to use for the upload

Returns:

Zenodo response to the request

update_zenodo_dataset(zenodo_url, dataset_id, zenodo_token, zenodo_dict)

Update a dataset’s metadata at the given Zenodo link.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • dataset_id – Zenodo dataset ID

  • zenodo_token – Zenodo personal token

  • zenodo_dict – Zenodo metadata dictionary, as returned by ZenodoMetadata.as_dict()

Returns:

Zenodo dataset ID

upload_zenodo_assets(zenodo_url, dataset_id, zenodo_token, assets, path)

Upload assets to a Zenodo dataset.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • dataset_id – Zenodo dataset ID

  • zenodo_token – Zenodo personal token

  • assets (list) – locations of assets to upload

  • path – location where the assets are collected before upload

delete_zenodo_dataset(zenodo_url, dataset_id, zenodo_token)

Delete a draft record from Zenodo.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • dataset_id – Zenodo record ID

  • zenodo_token – Zenodo personal token

get_zenodo_dataset(zenodo_url, dataset_id, zenodo_token)

Get a record from Zenodo.

Parameters:

  • zenodo_url – URL to the Zenodo repository

  • dataset_id – Zenodo record ID

  • zenodo_token – Zenodo personal token