Extension Calendar


Extension Basics

Title
Calendar
Name
ckanext-calendar
Type
Public extension
Description
The **Calendar** extension for CKAN provides API actions to manage and display calendar events with
CKAN versions
Download-Url (zip)
Last commit
4 years ago (2021-04-07 15:38:05)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-calendar

Build Status

This extension provides an API for using calendar events in CKAN. Standard CRUD operations can be used.

Development Installation

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

git clone https://github.com/ViderumGlobal/ckanext-calendar.git
cd ckanext-calendar
python setup.py develop
pip install -r dev-requirements.txt

Config Settings

Add shown events per page limit, default max is 3:

ckanext.calendar.events_show_limit = ...

Add pagination pages shown limit, default max is 3::

ckanext.calendar.pagination_limit = ...

Number of events shown in the recent events sidebar, defaults to 5::

ckanext.calendar.recent_events_limit = 10

The limit for truncating event description, default: 100

ckanext.calendar.truncate_limit = ...

API

Available actions to use:

All above actions can be used both from code with the get_action() method, or through the API.

All actions require sysadmin user, except for event_show and event_list which are public and don’t require an authenticated user.

Note: Parameters prefixed with * are required.

event_create

The event_create action is used to create a single event. It takes the following input parameters:

Parameter Type Description
*title string Title of an event.
*start string Start date of an event in ISO format.
*end string End date of an event in ISO format.
description string Description of an event.
venue string Venue of an event.
active boolean State of an event
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Settings Add shown events per page limit, default max is 3: ckanext.calendar.events_show_limit = ... Add pagination pages shown limit, default max is 3:: ckanext.calendar.pagination_limit = ... Number of events shown in the recent events sidebar, defaults to 5:: ckanext.calendar.recent_events_limit = 10 The limit for truncating event description, default: 100 ckanext.calendar.truncate_limit = ...

Plugins to configure (ckan.ini)
calendar
CKAN Settings (ckan.ini)
# ckanext.calendar.events_show_limit = ...
# ckanext.calendar.pagination_limit = ...
# ckanext.calendar.recent_events_limit = 10
# ckanext.calendar.truncate_limit = ...
DB migration to be executed
(not set)
<< back to Extensions