Add custom JSON mappings

[skasberger]

Implement mapping from and to custom JSON.

Requirements

• custom JSON mapping: Dataverse, Dataset, Datafile
• import from custom JSON
• export to custom JSON
• JSON schema
• validate data against schema

ACTIONS

0. Pre-Requisites

• Part of re-factor models module Re-factor models module #102

1. Research

• [ ]

2. Plan

• Define requirements

3. Implement

• Write tests
  • Create Mapping File
• Write code
• Update Docs
  • Basic Usage
  • Advanced Usage
  • Quickstart
• Write Docstrings
• Run pytest
• Run tox
• Run pylint
• Run mypy

4. Follow Ups

• Review
  • Code
  • Tests
  • Docs

Follow-Ups

• Re-factor models module Re-factor models module #102

[poikilotherm]

I am about to do sth really similar for CodeMeta in a plugin for GDCC/dvcli.

I want to create a small crosswalk from CodeMeta to Dataverse JSON datasets.

[skasberger]

Great. I started to have a look around on how to do that and the best option I have found was jsonbender for to/from JSON mappings. If you know any better ways how to solve this problem in a convenient and beautiful way, I would be very happy to know. :)

[pdurbin]

As discussed during the 2024-02-14 meeting of the pyDataverse working group, we are closing old milestones in favor of a new project board at https://github.com/orgs/gdcc/projects/1 and removing issues (like this one) from those old milestones. Please feel free to join the working group! You can find us at https://py.gdcc.io and https://dataverse.zulipchat.com/#narrow/stream/377090-python