Skip to main content

Preview for datasets

Project description

Travis (.org) GitHub All Releases GitHub Issues GitHub PR Licence Pypi py version Last Commit

CKAN dataset preview

Still in a develpment status

Adds automatically charts for all datasets in the dataset list. Uses messytables to discover field types.

How to set up?

General extension config values

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 with show any preview
ckanext.datasetpreview.draw = 'ALL'  # default draw all
ckanext.datasetpreview.chart_height = 300  # pixels

Each dataset could add and extra value with nthe key dataset_preview:

extras["dataset_preview"] = {
    // field to use in the chart. Could be:
    // - A list of field names (valids in the CSV resource)
    // Default will be [0, 1] ( the first two columns in the CSV). You could use numbers instead of field names
    "fields": ["Field1", "Field2"],  
    "chart_type": "Bar", // Allows 'Pie', 'Bar', 'Column'
    // URL could be:
    // - A external url
    // - No use this value: will be "csv_resource" with pick the first CSV resource in the dataset
    // - Name of the resource in the datasets (must be a CSV one)
    "url": "csv_resource",
    "height": 450,  // pixels
    "chart_color": "#AA5521"
}

If you don't setup each dataset it will show the first CSV resource in the dataset (using the first two columns)

dataset-list dataset-list

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext-datasetpreview-0.2.38.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

ckanext_datasetpreview-0.2.38-py2-none-any.whl (11.1 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page