Extension Plotly


Extension Basics

Title
Plotly
Name
ckanext-plotly
Type
Public extension
Description
The **ckanext-plotly** extension provides CKAN users with the ability to create and view charts usi
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-09-09 12:06:20)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

Tests

ckanext-plotly

CKAN Chart viewer / builder built around plotly.js and the Plotly react-chart-editor

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.7 and earlier no
2.8 not tested
2.9 yes

Installation

For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-plotly:

  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/USEPA/ckanext-plotly.git cd ckanext-plotly pip install -e . pip install -r requirements.txt

  3. Add plotly and/or plotly_explorer to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN

Config settings

None at present

Developer installation

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

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

Rebuilding the editor/explorer

The editor/explorer is built off of react-chart-editor. At present this being react based application necessitates some effort to export for use as a CKAN javascript asset. To accomplish this the following manual process is has been employed. A customized build process would be a great addition!

  1. Build the editor interface via npm:

    cd ckanext-plotly/editor_app/src npm run build

  2. Copy the built js and cs

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-plotly:

  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/USEPA/ckanext-plotly.git cd ckanext-plotly pip install -e . pip install -r requirements.txt

  3. Add plotly and/or plotly_explorer to the ckan.plugins setting in your CKAN c

Plugins to configure (ckan.ini)
plotly
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions