Code Monkey home page Code Monkey logo

dataverse-exporters's Introduction

Dataverse Exporters

A collection of community-developed metadata exporters that conform to the Dataverse Exporter Service Provider Interface (SPI).

Community members are encouraged to contribute to the documentation, add crosslinks, and create additional exporters! See below for more information.

In this repository you will find the Parent POM for all exporters as well as a very simple example exporter (see /example).

How to get support for exporters

All the projects below are made by the community for the community. While IQSS might contribute, please don't pester them with support request.

You are welcome to ask questions in the chat: https://chat.dataverse.org Please ask development related questions in #dev, anything else in #community or #troubleshoot.

In case of a concrete problem with one of the exporters, please create a reproducible issue in the respective GitHub project.

List of known exporters

Community supported GDCC projects

Quick links:

Name/Source Description Format Download
Example A minimalistic example, may be used as template JSON -
Debug Dumps all possible JSON and XML data available to export plugins JSON, XML TBD
DDI-PDF Export DDI metadata as a printable PDF file PDF with DDI metadata TBD
Croissant Export metadata as linked data following Croissant ontology JSON-LD TBD
RO-Crate Export metadata as linked data following RO-Crate ontology JSON-LD TBD

Other projects

If you have an exporter plugin that cannot or shall not be transferred to GDCC, feel free to open an issue or pull request to let us know.

Creating new exporters

Documentation of the exporter SPI is available under Advanced Installation and Metadata Export.

What are GDCC supported combinations of libraries and Dataverse?

Version support matrix:

Supported Exporter Parent POM Dataverse SPI Dataverse Software
1.0.0 5.14
2.0.0 2.0.0 6.0 - recent

Other combinations might work. Your mileage may vary.

How to contribute an exporter to the GDCC

In order to add your Dataverse Metadata Export Plugin to https://github.com/gdcc, please follow these steps:

  • Use the parent POM provided in your build system
  • Add unit and integration tests for your exporter to validate functionality
  • Setup GitHub Actions to continuously verify functionality
  • Enable the Renovate Bot or Dependency Bot to update your dependencies regularly
  • Write documentation for your exporter. Especially make sure to indicate supported Dataverse software versions!
  • Open a contribution request at https://github.com/gdcc/dataverse-exporters/issues/new to get access to a repository, be included in the list above and enable releases.
  • Release your exporter on Maven Central. Credentials will be provided by GDCC admins. See below for more details.
  • Keep your exporter code well maintained. Keep a changelog.

Please note that abandoned projects can and will be archived to ensure smooth operations for admins/users.

How to release an exporter in the name of GDCC

Once you received your exporter repository under https://github.com/gdcc, you can enable release workflows. Simply copy these files to your repository and ... (To Be Done)

Link to Dataverse SPI

dataverse-exporters's People

Contributors

poikilotherm avatar renovate[bot] avatar qqmyers avatar pdurbin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.