Extension Dataset Syndication


Extension Basics

Title
Dataset Syndication
Name
ckanext-syndicate
Type
Public extension
Description
Syndicate (push) datasets to remote CKAN instances
CKAN versions
Download-Url (zip)
Download-Url commit date
2021-09-23
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Comprehensive plugin to syndicate datasets from a local CKAN instance to one or more remote CKAN instances. When a dataset has the ‘syndicate’ flag set to True in its custom metadata, any updates are automatically reflected in the syndicated versions. Resources in syndicated datasets are stored as URLs pointing to the original resources. Supports multiple syndication profiles for pushing to different portals simultaneously, organization replication, name prefixing, and custom metadata fields. Version 2.0+ supports only CKAN 2.9+ and Python 3.7+ with a complete rework using signals instead of actions. ISyndicate interface allows plugins to modify syndication data or react to before/after syndication events via blinker signals. Includes CLI commands for mass syndication: ‘ckan syndicate sync [ID]’ for syndication and ‘ckan syndicate check [ID]’ to preview profiles. Requires API key for target CKAN instances and supports SSL with pyOpenSSL.

Version
2.3.1
Version release date
2021-09-23
Contact name
Aptivate
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: git clone https://github.com/aptivate/ckanext-syndicate.git, pip install -e ckanext-syndicate. Add ‘syndicate’ to ckan.plugins. WARNING: v2.0+ supports only CKAN 2.9+ and Python 3.7+, reworked to use signals instead of actions. For Python 2 support use v1 tags (v1.1.0). Multiple Syndication Profiles: Configure profiles as ckanext.syndicate.profile..

Plugins to configure (ckan.ini)
syndicate
CKAN Settings (ckan.ini)
# ckanext.syndicate.profile.PROFILE_ID.api_key = 9efdd954-c643-444a-97a1-c9c374cef861 # ckanext.syndicate.profile.PROFILE_ID.flag = syndicate_to_hdx # ckanext.syndicate.profile.PROFILE_ID.field_id = hdx_id # ckanext.syndicate.profile.PROFILE_ID.name_prefix = my-prefix # ckanext.syndicate.profile.PROFILE_ID.organization = my-org-name # ckanext.syndicate.profile.PROFILE_ID.replicate_organization = yes # ckanext.syndicate.profile.PROFILE_ID.author = some_user_name
DB migration to be executed
(not set)
<< back to Extensions