Extension Fairdatapoint


Extension Basics

Title
Fairdatapoint
Name
ckanext-fairdatapoint
Type
Public extension
Description
The `fairdatapoint` extension for CKAN provides a harvester specifically designed for FAIR (Findabl
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-03-22 14:15:38)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Tests

ckanext-fairdatapoint

CKAN harvester for FAIR Data Point. Contains a harvester for FAIR data points. In the future, the FAIR data point API might be supported by this extension too.

Stages

The harvester runs in three stages. Each of these stages can be modified. 1. Gather stage. The gather stage uses the FairDataPointRecordProvider which implements the IRecordProvider interface to create a list of identifiers of the objects which should be included in the harvest. In case of a FAIR data point, this list includes catalogs and datasets. In the future, collections could be added; 2. Fetch stage. The fetch stage downloads the actual source data. In this phase, additional data from other sources may be included to better suit the DCAT profile as expected by CKAN; 3. Import stage. The import stage does the actual import. How the RDF from the FAIR data point is mapped to CKAN packages and resources is determined by so-called application profiles. In case of a FAIR data point which uses custom fields, a profile must be created. A profile can be defined as a Python class in the ckanext.fairdatapoint.profiles.py file. The new profile must be registered in the [ckan.rdf.profiles] section of setup.py. What profile is being used for a particular is determined by the harvester configuration.

{ "profiles": "fairdatapoint_dcat_ap" }

To run the harvester from the command line:

ckan --config=<full path to CKAN ini-file> harvester run-test <id of harvester>

To rebuild the index in case it is not automatically update after clearing all packages from a harvester:

ckan --config=<full path to CKAN ini-file> search-index rebuild

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and e
Version
0.0.3
Version release date
2024-03-22
Contact name
Civity
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-fairdatapoint:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com/CivityNL/ckanext-fairdatapoint.git cd ckanext-fairdatapoint pip install -e . pip install -r requirements.txt

Plugins to configure (ckan.ini)
fairdatapoint
CKAN Settings (ckan.ini)
# ckanext.fairdatapoint.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions