This is a library for writing Python applications that make use of Dataverse APIs v4.0. The intent is to publish the python client on https://pypi.python.org.

$ pip install -e git+https://github.com/IQSS/dataverse-client-python.git#egg=dataverse

Requires Python >= 2.6.

To use the python client, you will need a dataverse account and an API token.

from dataverse import Connection

host = 'apitest.dataverse.org'                  # All clients >4.0 are supported
token = '4d0634d3-74d5-4770-8088-1971847ac75e'  # Generated at /account/apitoken

connection = Connection(host, token)

Dataverse Objects can be retrieved from their respective containers

dataverse = connection.get_dataverse('ALIAS')
dataset = dataverse.get_dataset_by_doi('DOI:10.5072/FK2/ABC123')
files = dataset.get_files('latest')

Create a file at settings/local.py. The file should contain the following information:

DEFAULT_HOST = "apitest.dataverse.org"
DEFAULT_TOKEN = "" # Token can be generated at {host}/account/apitoken

Do not commit this file.

In order to run any tests, you must first create a Dataverse on the host you wish to test. Do not run tests on the production server.

To run tests:

$ cd dataverse/test
$ python -m unittest test_dataverse