dva is a command line tool to upload and download files from a Dataverse instance.
- python - version 3.7+
Create and activate a virtual environment, then install this tool:
python -m pip install git+https://github.com/Imageomics/dataverse-access.git
Downloading published data from a Dataverse requires a Dataverse URL. Uploading or downloading unpublished data requires a Dataverse URL and an API token.
The Dataverse URL can be specified:
- Using the
--url <url>argument - Setting the
DATAVERSE_URLenvironment variable - Within a config file
The Dataverse API token can be specified:
- Setting the
DATAVERSE_API_TOKENenvironment variable - Within a config file
To create the config file run the following command:
dva setup
This command will prompt you for your Dataverse URL and API token and create a config file
with these two values in your home directory. The config file is named .dataverse and is in
JSON format containing keys "url" and "token".
To use an alternate location for the config file set the DATAVERSE_CONFIG_PATH environment variable.
List files in an existing dataset identified by a doi.
dva ls <doi>
Listing files within published dataset with DOI doi:10.5072/FK2/B7LCCX in https://datacommons.tdai.osu.edu/.
dva ls doi:10.5072/FK2/B7LCCX --url https://datacommons.tdai.osu.edu/
Upload files to an existing dataset identified by a doi.
dva upload <file_or_folder> <doi>
Download files from a dataset identified by a doi.
dva download <doi> <destination_path>
Download files from the published dataset with DOI doi:10.5072/FK2/B7LCCX in https://datacommons.tdai.osu.edu/ into a subdirectory named data.
dva download doi:10.5072/FK2/B7LCCX data --url https://datacommons.tdai.osu.edu/