EasyDataverse es una biblioteca de Python que se utiliza para interconectar instalaciones de Dataverse y generar dinámicamente objetos de Python compatibles con una configuración de bloque de metadatos proporcionada en una instalación de Dataverse. Además, EasyDataverse le permite exportar e importar conjuntos de datos desde y hacia varios formatos de datos.
Comience con EasyDataverse ejecutando el siguiente comando
# Using PyPI
pip install easyDataverse
O construir por fuente
pip install git+https://github.com/gdcc/easyDataverse.git
EasyDataverse es capaz de conectarse a una instalación de Dataverse determinada y recuperar todos los campos de metadatos y sus propiedades. Esto le permite crear un objeto de conjunto de datos con todos los campos de metadatos y sus propiedades proporcionadas en la instalación de Dataverse.
from easyDataverse import Dataverse
# Connect to a Dataverse installation
dataverse = Dataverse (
server_url = "https://demo.dataverse.org" ,
api_token = "MY_API_TOKEN" ,
)
# Initialize a dataset
dataset = dataverse . create_dataset ()
# Fill metadata blocks
dataset . citation . title = "My dataset"
dataset . citation . subject = [ "Other" ]
dataset . citation . add_author ( name = "John Doe" )
dataset . citation . add_dataset_contact ( name = "John Doe" , email = "[email protected]" )
dataset . citation . add_ds_description ( value = "This is a description of the dataset" )
# Upload files or directories
dataset . add_file ( local_path = "./my.file" , dv_dir = "some/dir" )
dataset . add_directory ( dirpath = "./my_directory" , dv_dir = "some/dir" )
# Upload to the dataverse instance
dataset . upload ( "my_dataverse_id" )
EasyDataset le permite descargar conjuntos de datos desde cualquier instalación de Dataverse. El conjunto de datos descargado se representa como una estructura orientada a objetos y se puede utilizar para actualizar metadatos/archivos, exportar un conjunto de datos a varios formatos o utilizarlo en aplicaciones posteriores.
# Method 1: Download a dataset by its DOI
dataverse = Dataverse ( "https://demo.dataverse.org" )
dataset = dataverse . load_dataset (
pid = "doi:10.70122/FK2/W5AGKD" ,
version = "1" ,
filedir = "place/for/data" ,
)
# Method 2: Download via URL
dataset , dataverse = Dataverse . from_ds_url (
url = "https://demo.dataverse.org/dataset.xhtml?persistentId=doi:10.70122/XX/XXXXX&version=DRAFT" ,
api_token = "MY_API_TOKEN"
)
# Display the content of the dataset
print ( dataset )
# Update metadata
dataset . citation . title = "My even nicer dataset"
# Synchronize with the dataverse instance
dataset . update ()
Puede encontrar un cuaderno de ejemplo completo en el directorio de ejemplos. Este cuaderno demuestra los conceptos básicos de EasyDataverse y cómo usarlo en la práctica.
EasyDataverse
es un software gratuito y de código abierto con licencia MIT.