Skip to content

SDM-TIB/ckanext-datacomparison

Repository files navigation

Latest Release License: AGPL v3

CKAN CKAN

Data Comparison

ckanext-datacomparison is a CKAN plugin replacing the original Data Explorer. This extension is inspired by the Data Explorer React (https://github.com/datopian/ckanext-dataexplorer-react).

The main feature of ckanext-datacomparison is the capability to compare data across resources. The visualizations are powered by plotly.js.

The following view plugins are part of ckanext-datacomparison:

  • datacomparison_view the view plugin providing the feature of comparing data across resources
  • datacomparison_explorer_view a view plugin acting like the Data Explorer using the same code basis as the comparison view

Note

The current version of datacomparison_explorer_view uses the first column of each resource for merging the data.

Installation

As usual for CKAN extensions, you can install ckanext-fedorkg as follows:

git clone [email protected]:SDM-TIB/ckanext-datacomparison.git
pip install -e ./ckanext-datacomparison
pip install -r ./ckanext-fedorkg/requirements.txt

Afterward, add datacomparison_view and/or datacomparison_explorer_view to the plugins in your ckan.ini.

Development

Prerequisites:

  • make 4.1 or newer
  • Python3 (including pip)
  • npm 7.0 or newer

The JavaScript and CSS dependencies are handled using npm. You can check the dependencies for updates by executing

make outdated

After changing the version number in package.json, execute the following command in order to install the updates and bundle the updated dependencies

make install && make bundle

Changelog

If you are interested in what has changed, check out the changelog.

License

ckanext-datacomparison is licensed under AGPL-3.0, see the license file.