Extension Gsreport


Extension Basics

Title
Gsreport
Name
ckanext-gsreport
Type
Public extension
Description
CKAN report infrastructure
CKAN versions
Download-Url (zip)
Last commit
7 years ago (2018-06-18 09:56:29)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-gsreport

CKAN report infrastructure.

Purpose

This CKAN extension provides reports about resources properties. Extension uses ckanext-report and adds reports to dashboard at /report.

Installation

This extension requires ckanext-report and owslib to be installed before using ckanext-gsreport.

  1. Install ckanext-report and init db:

$ git clone https://github.com/datagovuk/ckanext-report.git $ cd ckanext-report $ pip install -e . $ paster –plugin=ckanext-report report initdb –config=path/to/config.ini

  1. Clone repository and install package:

$ git clone https://github.com/geosolutions-it/ckanext-gsreport.git $ cd ckanext-gsreport $ pip install -r requirements.txt $ pip install -e .

  1. Add status_reports to plugins. Note Order of entries matters. This plugin should be placed before report plugin.

ckan.plugins = .. status_reports report

  1. Run solr data reindexing (license and resource format reports are using special placeholders in solr to access data without value):

paster –plugin=ckan search-index rebuild_fast -c /path/to/config.ini

  1. Run reports generation (see [Report generation] below)

After reports are generated, They can be seen in dashboard in /report path, for example http://localhost:5000/report

Report generation

Report can be generated in two ways:

  • in CLI (this can be used to set up cron job):

    • generate all reports:

    paster –plugin=ckanext-report report generate –config=path/to/config.ini

    • generate one report

    paster –plugin=ckanext-report report generate $report-name –config=path/to/config.ini

  • in UI, opening /report url when user opens report page for the first time (with no data in report),

Warning ** this can take a while to produce results. Especially broken-links report may take significant amount of time, because it will check each resource for availability.**

**Report generation speed depends on network speed, response time from

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


Installation Guide

Configuration hints

This extension requires ckanext-report and owslib to be installed before using ckanext-gsreport.

  1. Install ckanext-report and init db:

$ git clone https://github.com/datagovuk/ckanext-report.git $ cd ckanext-report $ pip install -e . $ paster –plugin=ckanext-report report initdb –config=path/to/config.ini

  1. Clone repository and install package:

$ git clone https://github.com/geosolutions-it/ckanext-gsreport.git $ cd ckanext-gsreport $ pip install -r requirements.txt $ p

Plugins to configure (ckan.ini)
status_reports report 4
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions