易數據宇宙
v0.4.1
EasyDataverse 是一個 Python 函式庫,用於連接 Dataverse 安裝並動態產生與 Dataverse 安裝中給定的元資料塊配置相容的 Python 物件。此外,EasyDataverse 允許您從各種資料格式匯出和匯入資料集。
透過執行以下命令開始使用 EasyDataverse
# Using PyPI
pip install easyDataverse
或透過原始碼構建
pip install git+https://github.com/gdcc/easyDataverse.git
EasyDataverse 能夠連接到給定的 Dataverse 安裝並取得所有元資料欄位及其屬性。這允許您使用 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 允許您從任何 Dataverse 安裝下載資料集。下載的資料集表示為物件導向的結構,可用於更新元資料/檔案、將資料集匯出為各種格式或在後續應用程式中使用它。
# 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 ()
您可以在範例目錄中找到完整的範例筆記本。本筆記本示範了 EasyDataverse 的基本概念以及如何在實務中使用它。
EasyDataverse
是一種根據 MIT 許可證授權的免費開源軟體。