Metadata-Version: 2.1
Name: ckanext-datasetpreview
Version: 0.2.36
Summary: Preview for datasets
Home-page: https://github.com/avdata99/ckanext-datasetpreview
Author: Andres vazquez
Author-email: andres@data99.com.ar
License: MIT
Description: [![Travis (.org)](https://img.shields.io/travis/avdata99/ckanext-datasetpreview?style=for-the-badge)](https://travis-ci.org/github/avdata99/ckanext-datasetpreview)
        [![GitHub All Releases](https://img.shields.io/github/downloads/avdata99/ckanext-datasetpreview/total?style=for-the-badge)](https://github.com/avdata99/ckanext-datasetpreview/releases)
        [![GitHub Issues](https://img.shields.io/github/issues/avdata99/ckanext-datasetpreview?style=for-the-badge)](https://github.com/avdata99/ckanext-datasetpreview/issues)
        [![GitHub PR](https://img.shields.io/github/issues-pr/avdata99/ckanext-datasetpreview?style=for-the-badge)](https://github.com/avdata99/ckanext-datasetpreview/pulls)
        [![Licence](https://img.shields.io/github/license/avdata99/ckanext-datasetpreview?style=for-the-badge)](https://github.com/avdata99/ckanext-datasetpreview/blob/master/LICENSE)
        [![Pypi py version](https://img.shields.io/pypi/pyversions/ckanext-datasetpreview?style=for-the-badge)](https://pypi.org/project/ckanext-datasetpreview/)
        [![Last Commit](https://img.shields.io/github/last-commit/avdata99/ckanext-datasetpreview?style=for-the-badge)](https://github.com/avdata99/ckanext-datasetpreview/commits/master)
        
        # 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
        
        ```ini
        # 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`:
        
        ```js
        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](ckanext/datasetpreview/captures/dataset-list.png)
        ![dataset-list](ckanext/datasetpreview/captures/chart-config.png)
        
Keywords: CKAN chart preview
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 2.7
Description-Content-Type: text/markdown
