Fairly Toolset Documentation

A toolset for creating, publishing and cloning research datasets. It provides a structured yet flexible way to document datasets durig data analysis, prepare datasets for publication and archiving to multiple research data reposities. Fairly supports repositories based on the following technologies: Invenio (Zenodo), Figshare, Dejhuty (4TU.ResearchData), Data Foundry and Dataverse.

The toolset consist of:

• Fairly Package. A Python package with the core functionally which can be used directly on the Python interpreter.

• Fairly CLI. A command line interface for the terminal or shell bundled with the Python package.

• Jupyter-Fairly. An extesion for JupyterLab and Jupyter Notebook. It provides a graphical interface with basic functionality.

Quick Start

• Installation
  • Installing the Toolset
  • Installing Python Package Only

Tutorials

• Using the JupyterLab Extension
• Using the CLI
• Using the Python API

References

• CLI Reference
• API Reference

Indices and tables

• Index

• Module Index

• Search Page