Extension BAE Publisher


Extension Basics

Title
BAE Publisher
Name
ckanext-baepublisher
Type
Public extension
Description
CKAN extension that allows users to publish datasets in the FIWARE Business API Ecosystem as offerings in an easy way.
CKAN versions
Download-Url (zip)
Last commit
7 years ago (2018-07-24 14:48:52)
Url to repo
Category
Corporate & Business


Background Infos

Description (long)
Show details

CKAN BAE Publisher

Build Status Coverage Status

CKAN extension that allows users to publish datasets in the FIWARE Business API Ecosystem GE as offerings in an easy way. To do so, a new tab is added in the Datasets Manage menu that offers a form to set the basic options of the offering.

Offerings are not automatically published so the dataset creator must access this form and complete it in order to publish the dataset using the FIWARE Business API Ecosystem.

Note: This software is intended to integrate a CKAN instance with the FIWARE Business API Ecosystem and it won’t work with other Marketplaces/Stores.

Requirements

Installation

Install this extension in your CKAN instance is as easy as intall any other CKAN extension.

  • Activate your virtual environment (generally by running . /usr/lib/ckan/default/bin/activate)
  • Install the extension by running pip install ckanext-baepublisher
  • Modify your configuration file (generally in /etc/ckan/default/production.ini) and add baepublisher in the ckan.plugins setting.
  • In the same config file, specify the location of FIWARE BAE to use by adding the ckan.baepublisher.store_url setting.
  • Restart your apache2 reserver (sudo service apache2 restart)
  • That’s All!

Tests

This sofware contains a set of test to detect errors and failures. You can run this tests by running the following command:

nosetests --ckan --with-pylons=test.ini ckanext/baepublisher/tests/

Note: The test.ini file contains a link to the CKAN test-core.ini file. You will need to change that link to the real path of the file in your system (generally /usr/lib/ckan/default/src/ckan/test-core.ini).

You can also generate coverage reports by running:

nosetests --ckan --with-xunit --with-pylons=test.ini ckanext/baepublisher/tests/ --with-coverage --cover-package=ckanext.baepublisher --cover-inclusive --cover-erase . --cover-xml
Version
0.5
Version release date
2018-07-24
Contact name
Aitor Magan, Francisco de la Vega
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

This extension allows publishing CKAN datasets as offerings in the FIWARE Business API Ecosystem. It requires OAuth2 authentication and the Private Datasets extension. A new ‘Publish’ tab appears in the dataset management interface. Configure the BAE Store URL and optionally disable SSL verification for development environments.

Plugins to configure (ckan.ini)
baepublisher
CKAN Settings (ckan.ini)
# CKAN BAE Publisher Configuration

# URL of the FIWARE Business API Ecosystem store
# ckan.baepublisher.store_url = https://marketplace.example.com

# Alternatively, set via environment variable:
# CKAN_BAEPUBLISHER_STORE_URL = https://marketplace.example.com

# For development only: Disable SSL verification (not recommended for production)
# OAUTHLIB_INSECURE_TRANSPORT = 1
DB migration to be executed
(not set)
<< back to Extensions