Extension Reminder


Extension Basics

Title
Reminder
Name
ckanext-reminder
Type
Public extension
Description
The **Reminder** extension for CKAN enhances data management by providing automated email notificat
CKAN versions

~2.5.2

Show details

These CKAN Versions are exactely matched:

Download-Url (zip)
Last commit
8 months ago (2025-04-30 11:44:34)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

=============

ckanext-reminder

This extension has two main functions.

  1. The extension provides simple email notifications for datasets which have a set data-expiry date. The extension relies on a daily cronjob during which datasets are checked if the reminder-data is set to current date. The email sending process is not retried in any way and the emails will not be sent if the cronjob fails to run for some reason.

  2. The extension provides a subscription form snippet which can be added to dataset templates. Users can submit their email address and receive notifications of these specific datasets when they are updated. The user can unsubscribe from any datasets by clicking the link located at the bottom of the email.


Requirements

This extension is developed and tested with CKAN version 2.5.2 but versions starting from 2.2 should work fine. This extension also needs Bootstrap 3+ for styling to work properly. Bootstrap 2 should mainly be fine, but styles might be a bit off at least with the subscription_form template.


Installation

To install ckanext-reminder:

  1. Activate your CKAN virtual environment, for example::

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

  2. Install the ckanext-reminder Python package into your virtual environment::

    pip install ckanext-reminder

  3. Add reminder to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu::

    sudo service apache2 reload

  5. Configure fields in the CKAN config file, the required configurations are listed below in the section “Config Settings”.

  6. Initialize database tables used by the subscribe to email notifications functionality::

    paster –plugin=ckanext-reminder reminder init –config=YOUR_CONFIGURATION.ini

  7. Call the appropriate paster commands in e.g. a cronjo

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


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
reminder
CKAN Settings (ckan.ini)
# ckanext.reminder.site_url = https://<YOUR_SITE_URL>
# ckanext.reminder.email = <YOUR_EMAIL_ADDRESS>
# ckanext.reminder.date_field = <DATE_FIELD>
# ckanext.reminder.email_field = <MAINTAINER_EMAIL_ADDRESS>
# ckanext.reminder.recipient_name_field = <MAINTAINER_NAME_FIELD>
DB migration to be executed
(not set)
<< back to Extensions