Extension Featurednumber


Extension Basics


Background Infos

Description (long)
Show details

=============

ckanext-featurednumbers

Featured Numbers is a very simple plugin that displays a custom number (or a fact) on CKAN’s front page and links it to the corresponding dataset, for example:

805 million people were suffering from chronic undernourishment in 2012-2014 (link to UNO data)

You can register several numbers, with associated description, unit, specify if the unit comes before or after the number (U$1000 or 1000km), and add a link to a dataset from where this fact comes from.

The main motivation was the perception that such numbers call people’s attentionand incentivates the search and use of data.


Requirements

  • CKAN 2.0+

Installation

To install ckanext-featurednumbers:

  1. Activate your CKAN virtual environment, for example::

    . /usr/lib/ckan/default/bin/activate

  2. Install the ckanext-featurednumbers Python package into your virtual environment::

    pip install ckanext-featurednumbers

  3. Add featurednumbers 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


Config Settings

Document any optional config settings here. For example::

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

Development Installation

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

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

Running the Tests

To run the tests, do::

nosetests --nol
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
featurednumber
CKAN Settings (ckan.ini)
# ckanext.featurednumbers.some_setting = some_default_value
DB migration to be executed
(not set)
<< back to Extensions