Extension Announcements


Extension Basics

Title
Announcements
Name
ckanext-announcements
Type
Public extension
Description
Enables defining scheduled announcements in CKAN.
CKAN versions

~2.10,~2.11

Show details
Download-Url (zip)
Last commit
9 months ago (2025-05-09 19:03:22)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

ckanext-announcements

Allow users to define scheduled announcements.

Requirements

Compatibility with core CKAN versions:

CKAN Version Compatible
2.8 no
2.9 (py2) no
2.9 (py3) deprecated on 0.1.6
2.10 yes
2.11 yes

ckanext-announcements only works with Python 3.

Installation

To install ckanext-announcements:

  1. Activate your CKAN virtual environment:

    . /usr/lib/ckan/default/bin/activate
    
  2. Clone the source and install it on the virtualenv:

    git clone https://github.com/okfn/ckanext-announcements.git
    cd ckanext-announcements
    pip install -e .
    pip install -r requirements.txt
    
  3. Add announcements to the ckan.plugins setting in your CKAN config file.

  4. Update DB to add the announcements table:

    ckan db upgrade -p announcements
    
  5. Restart CKAN.

Config Settings

  • ckanext.announcements.limit_announcements (default: 50) - Limit for the announcement list
  • ckan.display_timezone - Start and end dates are displayed in the timezone defined in this CKAN core setting
Version
0.1.4
Version release date
2025-01-09
Contact name
Andres Vazquez
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Requires Python 3. Database migration required.

Plugins to configure (ckan.ini)
announcements
CKAN Settings (ckan.ini)
# ckanext.announcements.limit_announcements = 50
DB migration to be executed
-p announcements
<< back to Extensions