CLI
zenodo-rest
zenodo-rest [OPTIONS] COMMAND [ARGS]...
Options
- --token
Request a prompt to provide an authtoken to override ZENODO_TOKEN.
- Default
ENVVAR: ‘ZENODO_TOKEN’
- -e, --env <env>
Pass a path to a .env file to overwrite and add ENVVARS.
depositions
zenodo-rest depositions [OPTIONS] COMMAND [ARGS]...
create
Create a new deposition
zenodo-rest depositions create [OPTIONS]
Options
- --metadata <metadata>
Optional json of metadata for the deposition.
- --metadata_file <metadata_file>
Optional json file of metadata for the deposition.
- --prereserve-doi
Prereserve a DOI (not pushed to Datacite until deposition is published).
- --dest <dest>
A file to write the resulting deposition json representation to.
delete
Delete a not yet published deposition
DEPOSITION_JSON json representation of the deposition to be deleted
zenodo-rest depositions delete [OPTIONS] DEPOSITION_JSON
Arguments
- DEPOSITION_JSON
Required argument
delete-files
Delete files from the bucket of a not yet published deposition
DEPOSITION_JSON json representation of the deposition to be uploaded to.
zenodo-rest depositions delete-files [OPTIONS] DEPOSITION_JSON
Arguments
- DEPOSITION_JSON
Required argument
doi
Get DOIs related to depositions
zenodo-rest depositions doi [OPTIONS] COMMAND [ARGS]...
latest
Print the doi of the latest published version of the given deposition.
DEPOSITION_JSON json representation of the deposition
zenodo-rest depositions doi latest [OPTIONS] DEPOSITION_JSON
Options
- -f, --full-url
Return the full url of the latest draft’s DOI
Arguments
- DEPOSITION_JSON
Required argument
latest-draft
Print the DOI of the latest related deposition draft
DEPOSITION_JSON json representation of the deposition
zenodo-rest depositions doi latest-draft [OPTIONS] DEPOSITION_JSON
Options
- -f, --full-url
Return the full url of the latest draft’s DOI
Arguments
- DEPOSITION_JSON
Required argument
list
zenodo-rest depositions list [OPTIONS]
Options
- -q, --query <query>
Search query (using Elasticsearch query string syntax).
- --status <status>
Filter result based on deposit status (either draft or published)
- --sort <sort>
Sort order (bestmatch or mostrecent).Prefix with minus to change form ascending to descending (e.g. -mostrecent).
- --page <page>
Page number for pagination
- --size <size>
Number of results to return per page.
- --all-versions <all_versions>
Show (true or 1) or hide (false or 0) all versions of deposits.
new-version
Create a new version of a published disposition
DEPOSITION_JSON json representation of the deposition to be published
zenodo-rest depositions new-version [OPTIONS] DEPOSITION_JSON
Options
- --dest <dest>
A file to write the resulting deposition json representation to.
Arguments
- DEPOSITION_JSON
Required argument
publish
Publish a pending deposition
DEPOSITION_JSON json representation of the deposition to be published
zenodo-rest depositions publish [OPTIONS] DEPOSITION_JSON
Options
- --dest <dest>
A file to write the resulting deposition json representation to.
Arguments
- DEPOSITION_JSON
Required argument
retrieve
Retrieve deposition by ID from server.
DEPOSITION-ID is the id of the deposition to be fetched
zenodo-rest depositions retrieve [OPTIONS] DEPOSITION_ID
Options
- --dest <dest>
A file to write the resulting deposition json representation to.
Arguments
- DEPOSITION_ID
Required argument
update
Update metadata for a not yet published deposition
DEPOSITION_JSON the file with a json representation of the deposition to be updated
METADATA_FILE the path to a metadata json file to be used as input
zenodo-rest depositions update [OPTIONS] DEPOSITION_JSON METADATA_FILE
Arguments
- DEPOSITION_JSON
Required argument
- METADATA_FILE
Required argument
upload-file
Upload a file to the bucket of a not yet published deposition
DEPOSITION_JSON json representation of the deposition to be uploaded to.
FILE the path to a file to be uploaded
zenodo-rest depositions upload-file [OPTIONS] DEPOSITION_JSON FILE
Arguments
- DEPOSITION_JSON
Required argument
- FILE
Required argument