ckanext-sweden

CKAN extension for Öppnadata.se, the Swedish data management platform.

Blog Plugin

To enable, activate your CKAN virtual environment and then:

1. Add sweden_blog to ckan.plugins.

2. Install the blog plugin's requirements:

   pip install -r ckanext/sweden/blog/requirements.txt

3. Run the paster command to initialize the blog's database tables:

   paster --plugin=ckan sweden_blog_init -c /etc/ckan/default/development.ini

4. Restart CKAN.

DCAT Harvesting

To enable, activate your CKAN virtual environment and then:

1. Install Redis, gcc and libffi-dev:

   sudo apt-get install redis-server build-essential libffi-dev

2. Install sweden_dcat_rdf_harvester requirements

   pip install -r ckanext/sweden/dcat/requirements.txt

3. Install ckanext-harvest:

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

4. Install ckanext-dcat:

   git clone https://github.com/ckan/ckanext-dcat
   cd ckanext-dcat
   pip install -r requirements.txt
   # tmp
   pip install lxml
   python setup.py develop

5. Add dcat_rdf_harvester sweden_dcat_rdf_harvester harvest to ckan.plugins ensuring harvest is listed after sweden_dcat_rdf_harvester

6. Restart CKAN.

You should see the harvest pages at /harvest and Generic DCAT RDF Harvester listed as a type on /harvest/new.

Configuration options

The following configuration options can be used with regards to the validation of remote DCAT documents:

• ckanext.sweden.harvest.use_validation (default: True): Whether to use validation at all
• ckanext.sweden.harvest.validation_service (default: http://validator.dcat-editor.com/service): The URL of the validation service to use. The harvester will POST the contents of the remote DCAT file to this endpoint.
• ckanext.sweden.harvest.stop_on_validation_errors (default False): Whether to stop the datasets import if validation errors were found.

Theme

To enable the theme:

1. Add sweden_theme to ckan.plugins

To modify the theme of the ckanext-sweden theme you'll need to:

1. Install Node (apt-get install node) and Bower (npm install -g bower)

2. Install the front end dependancies: cd ./ckanext/sweden/theme/ && npm i && bower update

3. Re-compile assets: gulp (gulp watch will regenerate them on the whenever a change happens.)

4. Once you've made your changes make sure you commit the changes in ./ckanext/theme/resources

Sweden Plugin and Eurovoc categories

To enable Eurovoc categories:

1. Install ckanext-eurovoc::

   pip install ckanext-eurovoc

2. Enable the Eurovoc and Sweden plugins by adding eurovoc and sweden to ckan.plugins.

Custom API endpoints

DCAT related API Endpoints

The sweden plugin adds the following API endpoints:

• dcat_organization_list: returns a list of all organizations that have DCAT harvesting set up. Returns a list of objects, one per organization, each of them with the following keys:

  • id: CKAN organization id
  • url: Organization website (unique across organizations)
  • dcat_metadata_url: DCAT output for the organization datasets (generated by CKAN)
  • original_dcat_metadata_url: The remote DCAT datasets that were harvested into Oppnadata.se
  • dcat_validation: Boolean showing whether the DCAT validation passed or not
  • dcat_validation_date: Date and time in which the DCAT validation last took place
  • dcat_validation_url: URL to the DCAT validation results

• dcat_validation: returns the validation output for the last harvest job of the organization harvest source. Requires an id parameter with the organization name or id.

Dataset Stats API Endpoints

The sweden_theme extension adds a number of additional API endpoints to retrieve data about datasets in the site.

• total_datasets_by_week: the cumulative total number of datasets by week.
• weekly_dataset_activity: the number of updates to datasets per week.
• weekly_dataset_activity_new: the number of new datasets per week.

e.g.:

curl http://127.0.0.1:5000/api/3/action/weekly_dataset_activity -H "Authorization:<your-api-key>"

Hide 'Groups'

Groups aren't used and can be hidden with the ckanext- hidegroups extension::

pip install -e 'git+git://github.com/okfn/ckanext-hidegroups.git#egg=ckanext-hidegroups'

Then add hidegroups to ckan.plugins.

Script for automated organizations creation

The extension includes a standalone script to automate the creation of organizations on the portal. For details, check the scripts folder.

Tests

To run the tests, first install the dev requirements (and Redis, see above):

pip install -r dev-requirements.txt

Then do:

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

To run the tests with coverage, first install coverage (pip install coverage) then do:

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