Extension Statscharts


Extension Basics

Title
Statscharts
Name
ckanext-statscharts
Type
Core extension
Description
This is the main repository for developing the statscharts extenstion for CKAN
CKAN versions

~1.5, ~2.11

Show details

These CKAN Versions are exactely matched:

Download-Url (zip)
Last commit
a year ago (2024-07-03 02:18:54)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-statsCharts

Statcharts is a CKAN extension developed to redesign the main website layout and add additional data summary features such as pie charts to display data, making Opendata usage more convenient and user-friendly.

Requirements

Users must install all extensions available in the NECTEC installation steps from the GitLab website.

If your extension works across different versions you can add the following table:

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9 not tested

Suggested values:

  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t work
  • “not yet” - there is an intention to get it working
  • “no”

Installation

To install ckanext-statsCharts:

  1. Activate Developer mode by typing the following command

    . /usr/lib/ckan/default/bin/activate
    
  2. Navigate to the following path

    cd /usr/lib/ckan/default
    
  3. Install the extension using the following command

    pip install -e 'git+https://github.com/JoNoteJoMaMa/ckanext-statscharts#egg=ckanext-statscharts'
    
  4. Add Statchart at the beginning of CKAN.PLUGIN in the ckan.ini file

    ckan.plugins = statscharts .....
    
  5. Reload CKAN:

    sudo supervisorctl reload
    

Config settings

None at present

TODO: Document any optional config settings here. For example:

# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.statscharts.some_setting = some_default_value

Developer installation

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

git clone https://github.com/JoNoteJoMaMa/ckanext-statsCharts.git
cd ckanext-statsCharts
python setup.py develop
pip install -r dev-requirements.txt

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

Releasing a new version of ckanext-statsCharts

If ckanext-statsCharts should be available on PyPI you can follow these steps to publish a new version:

  1. Update the version number in the setup.py file. See PEP 440 for how to choose version numbers.

  2. Make sure you have the latest version of necessary packages:

    pip install --upgrade setuptools wheel twine
    
  3. Create a source and binary distributions of the new version:

    python setup.py sdist bdist_wheel && twine check dist/*
    

    Fix any errors you get.

  4. Upload the source distribution to PyPI:

    twine upload dist/*
    
  5. Commit any outstanding changes:

    git commit -a
    git push
    
  6. Tag the new release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

    git tag 0.0.1
    git push --tags
    

License

AGPL

Version
Version release date
(not set)
Contact name
JoNoteJoMaMa
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Configuration Hints for ckanext-statsCharts

Installation

  1. Activate CKAN virtual environment:

    . /usr/lib/ckan/default/bin/activate
    cd /usr/lib/ckan/default
    
  2. Install extension:

    pip install -e 'git+https://github.com/JoNoteJoMaMa/ckanext-statscharts#egg=ckanext-statscharts'
    
  3. Add to ckan.ini:

    ckan.plugins = statscharts stats text_view image_view ...
    

    Note: Place statscharts at the beginning of the plugin list

  4. Restart CKAN:

    sudo supervisorctl reload
    

Optional Configuration

Add these settings to ckan.ini if needed:

ckanext.statscharts.cache_timeout = 24        # Cache timeout in hours
ckanext.statscharts.enable_pie_charts = true  # Enable/disable pie charts
ckanext.statscharts.max_datasets = 100        # Max datasets in charts

Troubleshooting

  • Extension not loading: Check ckan.plugins in config and review logs at /var/log/ckan/ckan.log
  • Charts not displaying: Clear browser cache and verify CKAN restart
Plugins to configure (ckan.ini)
statscharts
CKAN Settings (ckan.ini)
# ckanext.statscharts.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions