Extension JSON Patch


Extension Basics

Title
JSON Patch
Name
ckanext-jsonpatch
Type
Public extension
Description
CKAN extension enabling arbitrary, on-the-fly patching of JSON output dictionaries using the JSON Patch mechanism described by RFC6902.
CKAN versions
Download-Url (zip)
Last commit
5 years ago (2020-06-12 11:55:09)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-jsonpatch

An extension for CKAN enabling arbitrary, on-the-fly patching of JSON output dictionaries, using the JSON Patch mechanism described by RFC6902 (https://tools.ietf.org/html/rfc6902).

Requirements

This extension has been developed and tested with CKAN version 2.8.2.

Installation

Activate your CKAN virtual environment:

. /usr/lib/ckan/default/bin/activate

Install the latest development version of ckanext-jsonpatch and its dependencies:

cd /usr/lib/ckan/default
pip install -e 'git+https://github.com/SAEONData/ckanext-jsonpatch.git#egg=ckanext-jsonpatch'
pip install -r src/ckanext-jsonpatch/requirements.txt

In a production environment, you’ll probably want to pin a specific release version instead, e.g.:

pip install -e 'git+https://github.com/SAEONData/ckanext-jsonpatch.git@v1.0.0#egg=ckanext-jsonpatch'

Create the required database tables:

cd /usr/lib/ckan/default/src/ckanext-jsonpatch
paster jsonpatch initdb -c /etc/ckan/default/development.ini

Open your CKAN configuration file and add jsonpatch to the list of plugins:

ckan.plugins = ... jsonpatch

Restart your CKAN instance.

Version
1.0.0
Version release date
2020-06-12
Contact name
SAEON
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Requires database initialization: paster jsonpatch initdb

Plugins to configure (ckan.ini)
jsonpatch
CKAN Settings (ckan.ini)
# No specific environment variables required
DB migration to be executed
paster jsonpatch initdb -c /etc/ckan/default/development.ini
<< back to Extensions