Initial commit and release of doi2dataset

This commit is contained in:
Alexander Minges 2025-03-21 14:53:23 +01:00
commit 9be53fd2fc
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4
23 changed files with 2482 additions and 0 deletions

34
docs/source/index.rst Normal file
View file

@ -0,0 +1,34 @@
.. doi2dataset documentation master file, created by
sphinx-quickstart on Fri Mar 21 13:03:59 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
doi2dataset documentation
=========================
Overview
--------
**doi2dataset** is a Python tool designed to process DOIs and generate metadata for Dataverse datasets.
It retrieves data from external APIs such as OpenAlex and CrossRef and converts it into a format that meets Dataverse requirements.
Key Features:
- **Validation** and normalization of DOIs
- Retrieval and processing of **metadata** (e.g., abstract, license, author information)
- Automatic mapping and generation of metadata fields (e.g., title, description, keywords)
- Support for controlled vocabularies and complex (compound) metadata fields
- Optional **uploading** of metadata to a Dataverse server
- **Progress tracking** and error handling using the Rich library
.. toctree::
:maxdepth: 2
:caption: Contents:
:titlesonly:
introduction
installation
usage
modules
faq