Extension Announcements


Extension Basics

Title
Announcements
Name
ckanext-announcements
Type
Public extension
Description
Scheduled announcements
CKAN versions

~2.10, ~2.11

Show details
Download-Url (zip)
Last commit
8 months ago (2025-05-09 17:03:22)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

CKAN 2.11 CKAN 2.10

ckanext-announcements

Allow users to define scheduled announcements

Screen shot

Requirements

Compatibility with core CKAN versions:

ckanext-announcements only works with Python 3

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

Installation

To install ckanext-announcements:

  1. Activate your CKAN virtual environment, for example:

    . /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 (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Update DB to add the announcements table

    ckan db upgrade -p announcements

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

    sudo service apache2 reload

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

Developer installation

To install ckanext-announcements for development, activate your CKAN virtualenv and do:

git clone https://github.com/okfn/ckane
Version
0.1.4
Version release date
2025-01-09
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

To install ckanext-announcements:

  1. Activate your CKAN virtual environment, for example:

    . /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 (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Up

Plugins to configure (ckan.ini)
announcements
CKAN Settings (ckan.ini)
DB migration to be executed
upgrade
<< back to Extensions