Extension Rating


Extension Basics

Title
Rating
Name
ckanext-rating
Type
Public extension
Description
Rating system for datasets and showcases
CKAN versions

~2.8

Show details
Download-Url (zip)
https://github.com/DataShades/ckanext-rating.git#egg=ckanext-rating
Download-Url commit date
2017-02-17
Url to repo
https://github.com/DataShades/ckanext-rating
Category
Content Management


Background Infos

Description (long)
Show details

Simple rating extension for CKAN datasets (packages) and showcases. Adds clickable star ratings to side navigation in dataset and showcase templates similar to ckanext-qa. In showcases, stars are displayed in listing but not clickable. Stars can be added to any view via snippet. Ratings identified by client IP for unauthenticated users, by user ID for authenticated users. Works with CKAN 2.5+. Supports ckanext-showcase integration.

Version
0.0.1-2
Version release date
2017-02-17
Contact name
Mikko Nieminen
Contakt email
mikko.nieminen@gofore.com
Contact Url
(not set)


Installation Guide

Configuration hints

Installation:

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

pip install -e git+https://github.com/6aika/ckanext-rating.git#egg=ckanext-rating

Add rating to ckan.plugins

sudo service apache2 reload

Initialize database:

paster –plugin=ckanext-rating rating init –config=production.ini

For showcase integration:

Install ckanext-showcase: https://github.com/ckan/ckanext-showcase

Configuration:

rating.enabled_for_unauthenticated_users = true # Enable/disable for unauthenticated users

ckanext.rating.enabled_dataset_types = [‘dataset’] # List of dataset types for rating (optional, defaults to [‘dataset’])

Template snippets:

Add stars to any view:

{% snippet “rating/snippets/stars.html”, package= %}

Display rating count:

{{h.package_rating(None, {‘package_id’ : .id} ).ratings_count}}

Development:

git clone https://github.com/6aika/ckanext-rating.git

cd ckanext-rating

python setup.py develop

pip install -r dev-requirements.txt

Features:

- Clickable star ratings in dataset/showcase navigation

- Star display in showcase listings

- IP-based rating for unauthenticated users

- User ID-based rating for authenticated users

- Customizable via snippets

Plugins to configure (ckan.ini)
rating
CKAN Settings (ckan.ini)
# rating.enabled_for_unauthenticated_users = true or false
DB migration to be executed
rating
<< back to Extensions