-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -65,13 +65,15 @@ A Python CLI tool for extracting and exporting metadata from [Dataverse](https:/ | |
python3 dvmeta/main.py [-a AUTH] [-l] [-d] [-p] [-f] [-e] [-s] -c COLLECTION_ALIAS -v VERSION | ||
``` | ||
**Required arguments:** | ||
|
||
| **Option** | **Short** | **Type** | **Description** | **Default** | | ||
|--------------------|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| | ||
| --collection_alias | -c | TEXT | Name of the collection to crawl. <br/> **[required]** | None | | ||
| --version | -v | TEXT | The Dataset version to crawl. Options include: <br/> • `draft` - The draft version, if any <br/> • `latest` - Either a draft (if exists) or the latest published version <br/> • `latest-published` - The latest published version <br/> • `x.y` - A specific version <br/> **[required]** | None (required) | | ||
|
||
|
||
**Optional arguments:** | ||
|
||
| **Option** | **Short** | **Type** | **Description** | **Default** | | ||
|----------------------|-----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| | ||
| --auth | -a | TEXT | Authentication token to access the Dataverse repository. <br/> If | None | | ||
|
@@ -96,6 +98,7 @@ python3 dvmeta/main.py -c demo -v 1.0 -d -s -p -a xxxxxxxx-xxxx-xxxx-xxxx-xxxxxx | |
``` | ||
|
||
## 📂Output Structure | ||
|
||
| File | Description | | ||
|-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | ||
| ds_metadata_yyyymmdd-HHMMSS.json | Datasets' their data files' metadata in JSON format. | | ||
|
@@ -161,5 +164,4 @@ year = {2025} | |
``` | ||
|
||
## ✍️Authors | ||
Ken Lui - Data Curation Specialist, Map and Data Library, University of Toronto - [email protected] | ||
|
||
Ken Lui - Data Curation Specialist, Map and Data Library, University of Toronto - [[email protected]](mailto:[email protected]) |