Generate iCal files from a YAML description of meetings
Go to file
rbowen 4c4ae58575 Report which week a meeting occurs.
Change-Id: I1afcb7e657dd898279aa80c325a3adbfa5f40248
2021-07-15 16:41:52 +00:00
meetings Allow for meeting to be scheduled every 4 weeks. 2018-05-09 14:08:35 +01:00
yaml2ical Report which week a meeting occurs. 2021-07-15 16:41:52 +00:00
.gitignore Add DTSTAMP and UID values to meeting instances 2019-06-27 10:30:08 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:00 +00:00
.testr.conf Refactor Meeting init and enable unit tests 2014-06-30 16:39:07 +00:00
LICENSE Make code PEP8-compliant and add PEP8 test files 2014-04-03 18:50:40 -05:00 Make code PEP8-compliant and add PEP8 test files 2014-04-03 18:50:40 -05:00
README.rst Adds second- and fourth- week recurring meetings 2021-03-15 11:05:51 -04:00
requirements.txt Manual sync to global-requirements 2016-08-23 16:37:12 -07:00
setup.cfg update the versions of python 3 claimed 2018-11-02 13:57:38 -04:00 Make code PEP8-compliant and add PEP8 test files 2014-04-03 18:50:40 -05:00
test-requirements.txt Update hacking version 2021-07-15 14:49:54 +02:00
tox.ini H803 hacking have been deprecated 2020-02-13 10:48:15 +00:00



This tool converts a series of meeting descriptions in YAML format into one or several .ics files suitable for calendaring. It checks for scheduling conflicts in specific locations.


yaml2ical aims to provide an easier way to manage online team meetings.

This project allows to define each meeting with well-defined YAML files, which can be code-reviewed, then continuously-integrated into .ics files for general consumption.

Getting Started

Running Locally from Command Line

To test this project locally, you must have the following requirements installed:

  • Python 3.3+
  • iCalendar python library
  • PyYaml python library

Before running this tool, first edit some meeting YAML files in the meetings directory. To create a new meeting YAML file, read the YAML Meeting File section below.

$ pip install yaml2ical
$ yaml2ical
usage: yaml2ical [-h] -y YAML_DIR (-i ICAL_DIR | -o ICALFILE)
             [-t INDEX_TEMPLATE] [-w INDEX_OUTPUT] [-n CALNAME]
             [-d CALDESCRIPTION] [-f]

A tool that automates the process for testing, integrating, and
publishing changes to online meeting schedules.

optional arguments:
  -h, --help            show this help message and exit
  -y YAML_DIR, --yamldir YAML_DIR
                        directory containing YAML to process
  -i ICAL_DIR, --icaldir ICAL_DIR
                        output directory (one file per meeting)
  -o ICALFILE, --output ICALFILE
                        output file (one file for all meetings)
                        generate an index from selected meetings
  -w INDEX_OUTPUT, --indexoutput INDEX_OUTPUT
                        output index file
  -n CALNAME, --name CALNAME
                        name of calendar to set within the ical
                        description of calendar to set within the ical
  -f, --force           remove/overwrite previous output files

The following are a few scenarios:

Generate .ics files locally from existing yaml meeting files:

$ yaml2ical -y meetings/ -i icals/

The generated .ics files are not tracked in this git repository, but they are available locally to import into your calendar. Note, to remove stale .ics files, use the --force argument:

$ ls icals/
Barbican Meeting-b58d78a4.ics
Ceilometer Team Meeting-9ed7b5b4.ics
Chef Cookbook Meeting-2418b331.ics

With each .ics file looking something similar to:

$ cat icals/Barbican\ Meeting-b58d78a4.ics
PRODID:-//yaml2ical agendas//EN
SUMMARY:Barbican Meeting (openstack-meeting-alt)
DESCRIPTION:Project:  Barbican Meeting\nChair:  jraim\nIRC:  openstack-meet
 ing-alt\nAgenda:'* malini - update on Security Guide documentation\n\n  *
 alee_/atiwari - Crypto plugin changes\n\n  * arunkant - Target support in
 barbican policy enforcement\n\n  * jaraim - Support for debug mode start i
 n barbican\, can be merged?\n\n  '\n\nDescription:  The Barbican project t
 eam holds a weekly team meeting in\n#openstack-meeting-alt:\n* Weekly on M
 ondays at 2000 UTC\n* The blueprints that are used as a basis for the Barb
 ican project can be\n  found at\
 n* Notes for previous meetings can be found here.\n* Chair (to contact for
  more information): jraim (#openstack-barbican @\n  Freenode)\n

YAML Meeting File

Each meeting consists of:

  • project: the name of the project [MANDATORY]
  • schedule: a list of schedule each consisting of
    • time: time string in UTC [MANDATORY]
    • duration: duration of the meeting in minutes; defaults to 60
    • start_date: the date the first meeting takes place on or after.

      Format YYYYMMDD, all values must be zero-padded.

    • day: the day of week the meeting takes place [MANDATORY]
    • irc: the irc room in which the meeting is held [MANDATORY]
    • frequency: frequent occurrence of the meeting [MANDATORY]
    • skip_dates: A set of dates that the meeting DOES NOT happen on
      • skip_date: Skip the meeting for specified date. Format as start_date
      • reason: A comment for why the meeting was skipped
  • chair: name of the meeting's chair [MANDATORY]
  • description: a paragraph description about the meeting [MANDATORY]
  • agenda_url: a link to the agenda page for the meeting
  • project_url: a link to the project home page for the meeting

The file name should be a lower-cased, hyphenated version of the meeting name, ending with .yaml . For example, Keystone team meeting should be saved under keystone-team-meeting.yaml.

Any other values listed in the YAML file are also available for use in templates, making it easy to build links to agenda pages for the meeting or logs of past meetings. In the template file, use to access the value.


yaml2ical supports a number of possible frequency options:

  • Event occurs every week:
    • weekly: Event occurs every week.
  • Event alternates and starts on the next day:
    • biweekly-even: Occurs on even weeks (ISOweek % 2 == 0)
    • biweekly-odd Occurs on odd weeks (ISOweek % 2 == 1):
  • Event occurs every 4 weeks and starts on the next day:
    • quadweekly: Occurs when ISOweek % 4 == 0
    • quadweekly-week-1: Occurs when ISOweek % 4 == 1
    • quadweekly-week-2, quadweekly-alternate: Occurs when ISOweek % 4 == 2
    • quadweekly-week-3: Occurs when ISOweek % 4 == 3
  • Event occurs in a particular week of a month:
    • first-monday: On the first Monday of the month.
    • second-tuesday: On the second Tuesday of the month.
    • third-wednesday: On the third Wednesday of the month.
    • fourth-thursday: On the fourth Thursday of the month.
    • etc
  • Event doesn't happen on a defined schedule but is used as a placeholder for html generation:
    • adhoc


Odd/Even and week numbers are based on the ISO week number. ISO weeks can be checked with %V in GNU date(1)


All alternating meetings suffer from a probelm when years include an ISO week 53, this happened in 2015/2016 and happens approximately every 5 years.

Example 1

This is an example for the yaml meeting for Nova team meeting. The whole file will be import into Python as a dictionary.

  • The project name is shown below.

    project:  Nova Team Meeting
  • The schedule is a list of dictionaries each consisting of time in UTC, day of the week, the irc meeting room, and the frequency of the meeting. See above for notes on frequency.

    adhoc can be used to list the possibility of something in the schedule but will not actually generate any calendar events. This can be used for placeholders and will act as a noop when generating the calendar.

        - time:       '1400'
          day:        Thursday
          irc:        openstack-meeting-alt
          frequency:  biweekly-even
        - time:       '2100'
          day:        Thursday
          irc:        openstack-meeting
          frequency:  biweekly-odd
  • The chair is just a one liner.

    chair:  Russell Bryant
  • The project description is as follows. Use > for paragraphs where new lines are folded, or | for paragraphs where new lines are preserved.

    description:  >
        This meeting is a weekly gathering of developers working on OpenStack.
        Compute (Nova). We cover topics such as release planning and status,
        bugs, reviews, and other current topics worthy of real-time discussion.
  • An extra property containing the agenda for the meeting is saved in agenda_url and can be accessed in the template file as meeting.extras.agenda_url.

  • An extra property containing the project URL is saved in project_url and can be accessed in the template file as meeting.extras.project_url.

  • An extra property containing the MeetBot #startmeeting ID for the project is saved in meeting_id and can be accessed in the template file as meeting.extras.meeting_id.

    meeting_id: nova

Example 2

The following shows a complete YAML file for the IRC meetings for "example project". The project starts holding weekly meetings from October 1st, the project team has a "face to face" meeting on the 26th of October so that IRC meeting should be ommited from the ical schedule

  • This YAML

    project: Example Project Meeting
    meeting_id: example
    chair: A. Random Developer
    description:  >
        This meeting is a weekly gathering of developers working on Example
        - time:       '2100'
          day:        Monday
          irc:        openstack-meeting
          start_date: 20151001
          frequency:  weekly
          - skip_date: 20151026
            reason: Face 2 Face meeting at some location
  • Is converted into this iCal

    PRODID:-//yaml2ical agendas//EN
    SUMMARY:CANCELLED: Example Project Meeting (20151026T210000Z)
    DESCRIPTION:Face 2 Face meeting at some location
    SUMMARY:Example Project Meeting
    DESCRIPTION:Project:  Example Project Meeting\nChair:  A. Random Developer
     \nDescription:  This meeting is a weekly gathering of developers working o
     n Example project.\n\nAgenda URL:
     s/Example\nProject URL: