facile_rs.prepare_zenodo

Create an empty archive in Zenodo to reserve a DOI and a Zenodo ID.

Description

This script creates an empty archive in Zenodo in order to reserve a DOI and a Zenodo ID. Both are stored in the CodeMeta metadata file provided as input and can be later used by the script create_zenodo.py to populate the Zenodo archive.

Optionally, the script can create a new version from an existing Zenodo record. See the option –zenodo-version-update for more details.

Usage

usage: prepare_zenodo.py [-h] [--codemeta-location CODEMETA_LOCATION]
                         --zenodo-url ZENODO_URL --zenodo-token ZENODO_TOKEN
                         [--zenodo-version-update ZENODO_VERSION_UPDATE]
                         [--keep-previous-doi] [--dry] [--log-level LOG_LEVEL]
                         [--log-file LOG_FILE]

Named Arguments

--codemeta-location

Location of the main codemeta.json JSON file

--zenodo-url

URL of the Zenodo service. Test environment available at https://sandbox.zenodo.org

--zenodo-token

Zenodo personal token.

--zenodo-version-update

Enable Zenodo version update. Can be “codemeta” or a Zenodo identifier. If omitted, a new Zenodo dataset is created without versioning. If set to “codemeta”, a Zenodo identifier is searched in the CodeMeta file, and a new version is created from it (if found). Any other value is considered as a Zenodo identifier: a new version will be created from it.

--keep-previous-doi

When creating a new version, keep the previous DOI in the Codemeta file, in the field “isBasedOn”. By default, the previous DOI is removed.

Default: False

--dry

Perform a dry run, do not upload anything.

Default: False

--log-level

Log level (ERROR, WARN, INFO, or DEBUG)

Default: 'WARN'

--log-file

Path to the log file

Module Contents

Functions

create_parser
main
main_deprecated

API

create_parser(add_help=True)

main(args)

main_deprecated()