Skip to content

Custom CKAN Plugin for d3 visualization [Experiment with datastore]

License

Notifications You must be signed in to change notification settings

justicehub-in/ckanext-dataviz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ckanext-dataviz

CKAN Data Visualization plugin (Work in Progress)

https://user-images.githubusercontent.com/9320644/97192660-1f413100-17ce-11eb-9530-37d63dfa83a2.png

Requirements

Tested with CKAN Version 2.6 and 2.8

Installation

To install ckanext-dataviz:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
    
  2. Clone repository and install the ckanext-dataviz Python package into your virtual environment:

    python setup.py install
    
  3. Add dataviz_view to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload
    

Configuration

ckanext-dataviz has inbuilt themes integrated. To use one, add dataviz_theme to the ckan.dataviz_theme settings in your CKAN config file. If not provided, then it will take default theme. In case if theme is not found, then it will show: "Internal Server Error" in views section

Adding your own custom theme

There are mainly 2 steps for adding any custom theme:

  1. Add theme name in /dataviz/public/resource.config along with all the resources you want theme to load
  2. Add all relevant css/js files in their respective places inside /dataviz/public/ directory anywhere. By default we personally use theme directory inside public for custom styles.

Development Installation

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

git clone https://github.com/justicehub-in/ckanext-dataviz.git
cd ckanext-dataviz
python setup.py develop