Extension Dataproxy


Extension Basics


Background Infos

Description (long)
Show details

ckanext-dataproxy

ckanext-dataproxy is CKAN extension that enables previewing data from remote databases via SQLAlchemy. The extension is compatible with datastore by masking the dataproxy resource as a datastore resource so it could be requested via /api/3/action/datastore_search or previewed in-browser with recline-preview.

Usage:

Installation

NB! This module is developed for CKAN v2.2.x and v2.5.x, compatibility with other versions is not ensured

1) Clone this repo

cd /usr/lib/ckan/default/src
git clone https://github.com/cphsolutionslab/ckanext-dataproxy.git
cd ckanext-dataproxy

2) Activate your virtual environment, e.g.

. /usr/lib/ckan/bin/activate

3) Install requirements (It is not required to install drivers for databases you don’t plan to proxy, see the file)

pip install -r requirements.txt

Additional packages may be required to compile the database-specific drivers. For Ubuntu, you may need:

sudo apt-get install build-essential libmysqlclient-dev freetds-dev

4) Install the plugin

python setup.py develop

5) Set the dataproxy secret in your CKAN settings file (e.g. /etc/ckan/default/production.ini)

For example, in the settings file:

# Password for AES256 key generation
ckan.dataproxy.secret = c9f56fdfd12ee615f3d858... # Don't actually use this string, use a random secret.

You can run the following command in your shell to generate a random secret:

echo "import hashlib ; from uuid import uuid4 ; print hashlib.sha256(str(uuid4())).hexdigest()" | python -

Enable on CKAN 2.2.x

Enable the extension by appending dataproxy to ckan.plugins variable in your configuration file:

ckan.plugins = stats text_preview ... dataproxy

#

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


Installation Guide

Configuration hints

NB! This module is developed for CKAN v2.2.x and v2.5.x, compatibility with other versions is not ensured

1) Clone this repo

cd /usr/lib/ckan/default/src
git clone https://github.com/cphsolutionslab/ckanext-dataproxy.git
cd ckanext-dataproxy

2) Activate your virtual environment, e.g.

. /usr/lib/ckan/bin/activate

3) Install requirements (It is not required to install drivers for databases you don’t plan to proxy, see the file)
“` pip install -r requirements.txt “

Plugins to configure (ckan.ini)
stats text_preview stats text_preview
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions