fairly 2.0.0

Installing from source

1. Clone or download the source code:

   git clone https://github.com/ITC-CRIB/fairly.git

2. Go to the root directory:

   cd fairly/

3. Compile and install using pip:

   pip install .

Python API

Basic example to create a local research dataset and deposit it to a repository using the Python API:

import fairly

# Initialize a local dataset
dataset = fairly.init_dataset('/path/dataset')

# Set metadata
dataset.metadata['license'] = 'MIT'
dataset.set_metadata(
    title='My dataset',
    keywords=['FAIR', 'research', 'data'],
    authors=[
        '0000-0002-0156-185X',
        {'name': 'John', 'surname': 'Doe'}
    ]
)

# Add data files
dataset.includes.extend([
    'README.txt',
    '*.csv',
    'train/*.jpg'
])

# Save dataset
dataset.save()

# Upload to a data repository
remote_dataset = dataset.upload('zenodo')

Basic example to access a remote dataset and store it locally:

import fairly

# Open a remote dataset
dataset = fairly.dataset('doi:10.4121/21588096.v1')

# Get dataset information
dataset.id
>>> {'id': '21588096', 'version': '1'}

dataset.url
>>> 'https://data.4tu.nl/articles/dataset/.../21588096/1'

dataset.size
>>> 33339

len(dataset.files)
>>> 6

dataset.metadata
>>> Metadata({'keywords': ['Earthquakes', 'precursor', ...], ...})

# Update metadata
dataset.metadata['keywords'] = ['Landslides', 'precursor']
dataset.save_metadata()

# Store dataset to a local directory (i.e. clone dataset)
local_dataset = dataset.store('/path/dataset')

Command Line

fairly --help

You should see the following:

Usage: fairly [OPTIONS] [COMMAND] [ARGS]...

fairly command-line tool.

Options:
-v, --version  Show the version and exit.
-h, --help     Show this message and exit.

Commands:
client      Client commands.
dataset     Dataset commands.
repository  Repository commands.

Currently, the package supports the following research data management platforms:

• Invenio

• Figshare

• Djehuty (experimental)

All research data repositories based on the listed platforms are supported.

For more details and examples, consult the package documentation.