.. You should enable this project on travis-ci.org and coveralls.io to make these badges work. The necessary Travis and Coverage config files have been generated for you.

.. image:: https://github.com/ckan/ckanext-qa/actions/workflows/test.yml/badge.svg :target: https://github.com/ckan/ckanext-qa/actions/workflows/test.yml

CKAN QA Extension (Quality Assurance)

The ckanext-qa extension will check each of your dataset resources in CKAN and give them an 'openness score' based Tim Berners-Lee's five stars of openness (http://lab.linkeddata.deri.ie/2010/star-scheme-by-example)

The openness score is displayed as stars on the dataset and resource pages.

.. image:: qa_dataset.png :alt: Stars on the dataset

.. image:: qa_resource.png :alt: Stars spelled out on the resource

It also provides a report that allows you to view the openness (stars ratings) across a publisher or across them all:

.. image:: qa_report.png :alt: Openness report (star ratings) for a publisher

Requirements

Before installing ckanext-qa, make sure that you have installed the following:

CKAN 2.1+ (tests are only running for CKAN 2.7+)
ckanext-archiver 2.0+ (https://github.com/ckan/ckanext-archiver)
ckanext-report (https://github.com/datagovuk/ckanext-report) for reporting

Known issues:

if the CKAN version is earlier than 2.3 then QA and Archiver information will not display on the resource read page.

Installation

To install ckanext-qa, ensure you have previously installed ckanext-archiver (v2.0+) and ckanext-report and then:

Activate your CKAN virtual environment, for example::

. /usr/lib/ckan/default/bin/activate
Install the ckanext-qa Python package into your virtual environment::

pip install -e git+http://github.com/okfn/ckanext-qa.git#egg=ckanext-qa
Install the qa dependencies::

pip install -r ckanext-qa/requirements.txt
Now create the database tables::

paster --plugin=ckanext-qa qa init --config=production.ini
Add qa to the ckan.plugins setting BEFORE archiver in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).
Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::

sudo service apache2 reload

Upgrade from version 0.1 to 2.x

NB You should upgrade ckanext-archiver and ckanext-qa from v0.1 to 2.x in one go. Upgrade ckanext-archiver first and then carry out the following:

Activate your CKAN virtual environment, for example::

. /usr/lib/ckan/default/bin/activate
Upgrade the ckanext-qa Python package::

cd ckanext-qa git pull python setup.py develop
Create the new database tables::

paster --plugin=ckanext-qa qa init --config=production.ini
Install the normal and developer dependencies::

pip install -r requirements.txt pip install -r dev-requirements.txt
Migrate your database to the new QA tables::

python ckanext/qa/bin/migrate_task_status.py --write production.ini
(Re)start the paster celeryd2 run processes described for ckanext-archiver.

Configuration

You must make sure that the following is set in your CKAN config::

ckan.site_url = <URL to your CKAN instance>

Optionally you can configure a different set of scores to award each resource format::

qa.resource_format_openness_scores_json = <filepath>

The default value is resource_format_openness_scores.json)

Running

First, make sure that Celery is running for the priority and bulk queues. This is explained in the ckanext-archiver README:

Using Archiver

QA is performed when a dataset/resource is archived, or you can run it manually using a paster command::

paster --plugin=ckanext-qa qa update [dataset] --config=production.ini

Here dataset is a CKAN dataset name or ID, or you can omit it to do the QA on all datasets.

For a full list of manual commands run::

paster --plugin=ckanext-qa qa --help

Once the QA has run for a dataset, you will see the stars displayed on the dataset's web page, and the detected file format available when you call package_show for it, in the qa for the dataset and each resource.

You can get an overall picture by generating an Openness report::

paster --plugin=ckanext-report report generate openness --config=production.ini

And view it on your CKAN site at /report/openness.

Tests

To run the tests:

Activate your CKAN virtual environment, for example::

. /usr/lib/ckan/default/bin/activate
If not done already, install the dev requirements::

(pyenv)~/pyenv/src/ckan$ pip install ../ckanext-qa/dev-requirements.txt
From the CKAN root directory (not the extension root) do::

(pyenv)~/pyenv/src/ckan$ nosetests --ckan ../ckanext-qa/ckanext/qa/tests/ --with-pylons=../ckanext-qa/test-core.ini

If you get error "MagicException: None" then it may be due to libmagic needing an update. Try:

sudo apt-get install libmagic1

Translations

To translate plugin to a new language (ie. "pl") run python setup.py init_catalog -l pl.

To update template file with new translation added in the code or templates run python setup.py extract_messages in the root plugin directory. Then run ./ckanext/qa/i18n/unique_pot.sh -v to strip other plugin's translations.

To update translation files for locale "pl" with new template run python setup.py update_catalog -l pl.

Questions

The archiver info shows on the dataset/resource pages but the QA doesn't



You need to ensure that in your ``ckan.plugins`` you have ``qa`` listed BEFORE ``archiver`` or else the template inheritance doesn't work and this happens.

ckan / ckanext-qa

readme