https://github.com/federicoceratto/pelican-events

Pelican events plugin: scans blog posts for an events and generates an .ical calendar file.
https://github.com/federicoceratto/pelican-events

Last synced: 6 days ago
JSON representation

Pelican events plugin: scans blog posts for an events and generates an .ical calendar file.

• Host: GitHub
• URL: https://github.com/federicoceratto/pelican-events
• Owner: FedericoCeratto
• License: agpl-3.0
• Created: 2015-03-17T20:59:08.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-03-17T21:04:01.000Z (over 9 years ago)
• Last Synced: 2023-03-22T12:49:35.880Z (over 1 year ago)
• Language: Python
• Size: 145 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
events

----

This plugin scans blog posts for an events.

It also generates an ``.ical`` calendar file.

Dependencies

------------

This plugin depends on the ``icalendar`` package, which can be installed

using APT or RPM or, if you are unlucky, via pip::

    pip install icalendar

Usage

-----

Add the following to pelicanconf.py::

    PLUGIN_EVENTS = {

        'ics_fname': 'calendar.ics',

    }

Create articles and usual and add the "event-start" metadata to turn them into

events. The event start is independent of the article "date".

"event-start" is in "YYYY-MM-DD hh:mm" format.

Also add "event-end", in the same format, or "event-duration" as a number

followed by a dimension:

w: weeks

d: days

h: hours

m: minutes

s: seconds

You can also specify an optional "location"

Example in ReST format::

    :event-start: 2015-01-21 10:30

    :event-duration: 2h

    :location: somewhere

To generate an sorted event list in a dedicated page copy the events_list.html

template under the templates directory in your theme, then create a page:

content/pages/events_list.rst::

 Events list

 ###########

 :slug: events-list

 :summary:

 :template: events_list