Download easyDataverse - download do código-fonte easyDataverse

easyDataverse

Outro código-fonte

v0.4.1

Baixar

EasyDataverse é uma biblioteca Python usada para fazer interface com instalações do Dataverse e gerar dinamicamente objetos Python compatíveis com uma configuração de metadatablock fornecida em uma instalação do Dataverse. Além disso, EasyDataverse permite exportar e importar conjuntos de dados de e para vários formatos de dados.

Características

Classes compatíveis com Metadataconfig para criação flexível de conjuntos de dados.
Upload e download de arquivos e diretórios de e para instalações do Dataverse.
Exportação e importação de conjuntos de dados para diversos formatos (JSON, YAML e XML).
Obtenha conjuntos de dados de qualquer instalação do Dataverse em uma estrutura orientada a objetos pronta para ser integrada.

⚡️ Início rápido

Comece com EasyDataverse executando o seguinte comando

 # Using PyPI
pip install easyDataverse

Ou construa por fonte

pip install git+https://github.com/gdcc/easyDataverse.git

Início rápido

Criação de conjunto de dados

EasyDataverse é capaz de se conectar a uma determinada instalação do Dataverse e buscar todos os campos de metadados e suas propriedades. Isto permite-lhe criar um objeto de conjunto de dados com todos os campos de metadados e as respetivas propriedades fornecidas na instalação do 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" )

Download e atualização do conjunto de dados

EasyDataset permite baixar conjuntos de dados de qualquer instalação do Dataverse. O conjunto de dados baixado é representado como uma estrutura orientada a objetos e pode ser usado para atualizar metadados/arquivos, exportar um conjunto de dados para vários formatos ou usá-lo em aplicações subsequentes.

 # 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 ()

Documentação e mais exemplos

Você pode encontrar um caderno de exemplos completo no diretório de exemplos. Este notebook demonstra conceitos básicos do EasyDataverse e como usá-lo na prática.