easyDataverse-Download - easyDataverse-Quellcode-Download

easyDataverse

Anderer Quellcode

v0.4.1

Herunterladen

EasyDataverse ist eine Python-Bibliothek, die als Schnittstelle zu Dataverse-Installationen dient und dynamisch Python-Objekte generiert, die mit einer Metadatenblockkonfiguration kompatibel sind, die bei einer Dataverse-Installation angegeben wird. Darüber hinaus ermöglicht Ihnen EasyDataverse den Export und Import von Datensätzen in und aus verschiedenen Datenformaten.

Merkmale

Metadataconfig-kompatible Klassen für die flexible Erstellung von Datensätzen.
Hoch- und Herunterladen von Dateien und Verzeichnissen zu und von Dataverse-Installationen.
Export und Import von Datensätzen in verschiedene Formate (JSON, YAML und XML).
Rufen Sie Datensätze aus jeder Dataverse-Installation in eine objektorientierte Struktur ab, die zur Integration bereit ist.

⚡️ Schnellstart

Beginnen Sie mit EasyDataverse, indem Sie den folgenden Befehl ausführen

 # Using PyPI
pip install easyDataverse

Oder nach Quelle erstellen

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

Schnellstart

Datensatzerstellung

EasyDataverse ist in der Lage, eine Verbindung zu einer bestimmten Dataverse-Installation herzustellen und alle Metadatenfelder und ihre Eigenschaften abzurufen. Dadurch können Sie ein Datensatzobjekt mit allen Metadatenfeldern und ihren Eigenschaften erstellen, die bei der Dataverse-Installation angegeben wurden.

 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" )

Herunterladen und Aktualisieren des Datensatzes

Mit EasyDataset können Sie Datensätze von jeder Dataverse-Installation herunterladen. Der heruntergeladene Datensatz wird als objektorientierte Struktur dargestellt und kann zum Aktualisieren von Metadaten/Dateien, zum Exportieren eines Datensatzes in verschiedene Formate oder zur Verwendung in Folgeanwendungen verwendet werden.

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

Dokumentation und weitere Beispiele

Ein ausführliches Beispielnotizbuch finden Sie im Beispielverzeichnis. Dieses Notizbuch demonstriert die grundlegenden Konzepte von EasyDataverse und wie man es in der Praxis verwendet.