CKAN dataset preview
Note: Still in development status.
Adds automatically charts for all datasets in the dataset list. Uses messytables to discover field types.
Installation
pip install ckanext-datasetpreview
Or install from source:
git clone https://github.com/unckan/ckanext-datasetpreview.git
cd ckanext-datasetpreview
python setup.py develop
Add datasetpreview to your CKAN config file’s ckan.plugins setting.
Configuration
Available config options:
# Define if the extension should draw chart for:
# - 'ALL' All datasets with a CSV resource
# - 'EXTRA' Just datasets with the 'dataset_preview' extra dictionary defined
# - 'NO' No datasets will show any preview
ckanext.datasetpreview.draw = 'ALL' # default draw all
ckanext.datasetpreview.chart_height = 300 # pixels
Per-Dataset Configuration
Each dataset can add an extra value with the key dataset_preview:
extras["dataset_preview"] = {
# Field to use in the chart. Could be:
# - A list of field names (valid in the CSV resource)
# - Default will be [0, 1] (the first two columns in the CSV)
# - You can use numbers instead of field names
"fields": ["Field1", "Field2"],
"chart_type": "Bar", # Allows 'Pie', 'Bar', 'Column'
# URL could be:
# - An external URL
# - Don't use this value: will be "csv_resource" which picks the first CSV resource
# - Name of the resource in the dataset (must be a CSV)
"url": "csv_resource",
"height": 450, # pixels
"chart_color": "#AA5521"
}
If you don’t set up each dataset, it will show the first CSV resource in the dataset (using the first two columns).
License
MIT license