ckanext-dataexplorer-react: A Python repository from Datopian

Note that it should work on earlier CKAN versions but it hasn't been tested.

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:

Activate your CKAN virtual environment, for example::

. /usr/lib/ckan/default/bin/activate
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
Add dataexplorer_view to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini)
- dataexplorer_viewfor 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.
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