Extension Data Explorer React


Extension Basics

Title
Data Explorer React
Name
ckanext-dataexplorer-react
Type
Public extension
Description
A Data Explorer app for CKAN built in React that provides visualization features including table views, charts, maps, and SQL-like query builder for DataStore resources.
CKAN versions
Download-Url (zip)
Download-Url commit date
2023-03-16
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-dataexplorer-react

A new Data Explorer for CKAN built on React.

Features

A Data Explorer app for CKAN built in React:

  • Preview data from DataStore in a table.
    • Set predefined filters.
    • Set suggested filters.
  • Filter data using SQL-like query builder which calls datastore_search_sql API.
  • Build charts and maps similar to classic Data Explorer but with improved UI/UX.

Installation

⚠️ For CKAN v2.8, please use branch 2.8.

Important notice: if you’re using CKAN >v2.8.6 or >v2.9.1 you need to make sure that over function of Postgresql is enabled via datastore_search_sql endpoint. To do so you may need to add it into your allow list here - https://github.com/ckan/ckan/blob/master/ckanext/datastore/allowed_functions.txt

The React code repository is here - https://github.com/datopian/data-explorer.

To install ckanext-dataexplorer-react:

  1. Activate your CKAN virtual environment, for example::

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

  2. Install the ckanext-dataexplorer-react Python package into your virtual environment:: pip install -e git+https://github.com/datopian/ckanext-dataexplorer-react.git#egg=ckanext-dataexplorer-react

  3. Add the desired plugins to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini):

    • dataexplorer_view for multiview visualization table, chart and map.
    • Add dataexplorer_table_view for table view.
    • Add dataexplorer_chart_view for chart view.
    • Add dataexplorer_map_view for map view.
    • Add dataexplorer_web_view for external web view.
  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu::

    sudo service apache2 reload

Development Installation

To install ckanext-dataexplorer-react for development, activate your CKAN virtualenv and do::

git clone https://github.com/datopian/ckanext-dataexplorer-react.git
cd ckanext-dataexplorer-react
python setup.py develop
pip install -r dev-requirements.txt

Compatibility

Supports CKAN 2.8, 2.9, and 2.10. Note that it should work on earlier CKAN versions but it hasn’t been tested.

Version
0.0.1
Version release date
2020-04-01
Contact name
Datopian
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Provides React-based data visualization views for CKAN DataStore resources. Configure PostgreSQL ‘over’ function for advanced queries. Each view type can be enabled independently based on visualization needs.

Plugins to configure (ckan.ini)
dataexplorer_view dataexplorer_table_view dataexplorer_chart_view dataexplorer_map_view dataexplorer_web_view
CKAN Settings (ckan.ini)
# Data Explorer React Configuration # No specific configuration options documented # Extension works with default settings after plugin activation # # Note: For CKAN >v2.8.6 or >v2.9.1, ensure PostgreSQL 'over' function # is enabled in datastore allowed_functions.txt: # https://github.com/ckan/ckan/blob/master/ckanext/datastore/allowed_functions.txt
DB migration to be executed
(not set)
<< back to Extensions