Athemis/doi2dataset
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Clarify that we mean Dataverse.org; fix link to LICENSE.md

Browse source
This commit is contained in:
Alexander Minges 2025-03-21 14:55:54 +01:00
parent 9be53fd2fc
commit 05de961fb5
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,13 +1,13 @@
# doi2dataset
**doi2dataset** is a Python tool designed to process DOIs and generate metadata for Dataverse datasets. It retrieves metadata from external APIs (such as OpenAlex and CrossRef), maps metadata fields, and can optionally upload the generated metadata to a Dataverse instance.
**doi2dataset** is a Python tool designed to process DOIs and generate metadata for Dataverse.org datasets. It retrieves metadata from external APIs (such as OpenAlex and CrossRef), maps metadata fields, and can optionally upload the generated metadata to a Dataverse.org instance.
## Features
- **DOI Validation and Normalization:** Validates DOIs and converts them into a standardized format.
- **Metadata Retrieval:** Fetches metadata such as title, abstract, license, and author information from external sources.
- **Metadata Mapping:** Automatically maps and generates metadata fields (e.g., title, description, keywords) including support for controlled vocabularies and compound fields.
- **Optional Upload:** Allows uploading of metadata directly to a Dataverse server.
- **Optional Upload:** Allows uploading of metadata directly to a Dataverse.org server.
- **Progress Tracking:** Uses the Rich library for user-friendly progress tracking and error handling.
## Installation
@ -25,7 +25,7 @@ Configuration
Before running the tool, configure the necessary settings in the `config.yaml` file located in the project root. This file contains configuration details such as:
- Dataverse connection details (URL, API token, authentication credentials)
- Connection details (URL, API token, authentication credentials)
- Mapping of project phases
- Principal Investigator (PI) information
- Default grant configurations
@ -56,7 +56,7 @@ python doi2dataset.py [options] DOI1 DOI2 ...
Contact email address.
- `-u, --upload`
Upload metadata to a Dataverse server.
Upload metadata to a Dataverse.org server.
## Documentation
@ -76,4 +76,4 @@ Contributions are welcome! Please fork the repository and submit a pull request
## License
This project is licensed under the MIT License. See the [LICENSE.md] file for details.
This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.