Extension Plotly


Extension Basics

Title
Plotly
Name
ckanext-plotly
Type
Public extension
Description
CKAN chart viewer and builder built around plotly.js and the Plotly react-chart-editor, providing interactive data visualization capabilities.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2022-09-09 14:06:20)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

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

To install ckanext-plotly:

  1. Activate your CKAN virtual environment:

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

  2. Clone the source and install:

    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.

  4. Restart CKAN.

Config settings

None at present.

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.

  1. Build the editor interface via npm: cd ckanext-plotly/editor_app/src && npm run build
  2. Copy the built js and css bundles.
  3. Edit the source map in the final line.

Tests

pytest --ckan-ini=test.ini ckanext

Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an “as is” basis and the user assumes responsibility for its use.

License

AGPL-3.0

Version
0.0.1
Version release date
2022-09-09
Contact name
Paul DeKraker
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Add ‘plotly’ and/or ‘plotly_explorer’ to ckan.plugins. Requires CKAN 2.9+.

Plugins to configure (ckan.ini)
plotly plotly_explorer
CKAN Settings (ckan.ini)
# No specific environment variables documented
DB migration to be executed
(not set)
<< back to Extensions