Téléchargement easyDataverse - Téléchargement du code source easyDataverse

easyDataverse

Autre code source

v0.4.1

Télécharger

EasyDataverse est une bibliothèque Python utilisée pour interfacer les installations Dataverse et générer dynamiquement des objets Python compatibles avec une configuration de bloc de métadonnées donnée lors d'une installation Dataverse. De plus, EasyDataverse vous permet d'exporter et d'importer des ensembles de données vers et depuis différents formats de données.

Caractéristiques

Classes conformes aux métadonnées pour une création flexible d'ensembles de données.
Chargement et téléchargement de fichiers et de répertoires vers et depuis les installations Dataverse.
Exportation et importation d'ensembles de données vers différents formats (JSON, YAML et XML).
Récupérez des ensembles de données de n’importe quelle installation Dataverse dans une structure orientée objet prête à être intégrée.

⚡️ Démarrage rapide

Démarrez avec EasyDataverse en exécutant la commande suivante

 # Using PyPI
pip install easyDataverse

Ou construire par source

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

Démarrage rapide

Création d'un ensemble de données

EasyDataverse est capable de se connecter à une installation Dataverse donnée et de récupérer tous les champs de métadonnées et leurs propriétés. Cela vous permet de créer un objet ensemble de données avec tous les champs de métadonnées et leurs propriétés données lors de l'installation 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" )

Téléchargement et mise à jour du jeu de données

EasyDataset vous permet de télécharger des ensembles de données à partir de n'importe quelle installation Dataverse. L'ensemble de données téléchargé est représenté sous la forme d'une structure orientée objet et peut être utilisé pour mettre à jour des métadonnées/fichiers, exporter un ensemble de données vers différents formats ou l'utiliser dans des applications ultérieures.

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

Documentation et autres exemples

Vous pouvez trouver un exemple de cahier détaillé dans le répertoire des exemples. Ce cahier démontre les concepts de base d'EasyDataverse et comment l'utiliser dans la pratique.