isabella232 / ckanext-widgets

helper widgets to help render atom/rss feeds for CKAN themes

ckanext-widgets

Installation

To install ckanext-widgets:

1. Activate your CKAN virtual environment, for example:

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

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

   pip install -e git+https://github.com/ckan/ckanext-widgets.git#egg=ckanext-widgets
   

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

# Sets the the featured feed in the default layout widgets1 ckanext.widgets.featured_feed = https://feeds.feedburner.com/ckanproject # you will also need to set, or change in the admin page ckan.homepage_style = widgets1

Development Installation

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

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

Running the Tests

To run the tests, do:

nosetests --nologcapture --with-pylons=test.ini

To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:

nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.widgets --cover-inclusive --cover-erase --cover-tests