easyDataverse ダウンロード - easyDataverse ソースコードのダウンロード

easyDataverse

その他のソースコード

v0.4.1

ダウンロード

EasyDataverse は、Dataverse インストールとインターフェイスし、Dataverse インストールで指定されたメタデータブロック構成と互換性のある Python オブジェクトを動的に生成するために使用される Python ライブラリです。さらに、EasyDataverse を使用すると、さまざまなデータ形式間でデータセットをエクスポートおよびインポートできます。

特徴

柔軟なデータセット作成のためのMetadataconfig 準拠のクラス。
Dataverse インストールとの間でファイルとディレクトリをアップロードおよびダウンロードします。
データセットをさまざまな形式 (JSON、YAML、XML) にエクスポートおよびインポートします。
任意の Dataverse インストールからデータセットをオブジェクト指向構造にフェッチし、すぐに統合できます。

⚡️ クイックスタート

次のコマンドを実行して 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 ()