.. 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