yaml2ical 0.13.0

理由

yaml2ical旨在提供一种更简单的管理在线团队会议的方式。

此项目允许使用定义良好的YAML文件定义每次会议，这些文件可以经过代码审查，然后持续集成到.ics文件中，以便广泛使用。

入门

从命令行本地运行

要本地测试此项目，您必须安装以下要求

• Python 3.3+

• iCalendar python库

• PyYaml python库

在运行此工具之前，首先编辑会议目录中的某些会议YAML文件。要创建新的会议YAML文件，请阅读下面的《YAML会议文件》部分。

$ 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)
  -t INDEX_TEMPLATE, --indextemplate INDEX_TEMPLATE
                        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
  -d CALDESCRIPTION, --description CALDESCRIPTION
                        description of calendar to set within the ical
  -f, --force           remove/overwrite previous output files

以下是一些场景

从现有的yaml会议文件本地生成.ics文件

$ yaml2ical -y meetings/ -i icals/

生成的.ics文件不会在这个Git仓库中跟踪，但它们可以在本地导入到您的日历中。注意，要删除过时的.ics文件，请使用--force参数。

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

每个.ics文件看起来类似如下：

$ cat icals/Barbican\ Meeting-b58d78a4.ics
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//yaml2ical agendas//EN
BEGIN:VEVENT
SUMMARY:Barbican Meeting (openstack-meeting-alt)
DTSTART;VALUE=DATE-TIME:20141006T200000Z
DURATION:PT1H
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 https://blueprints.launchpad.net/barbican\
 n* Notes for previous meetings can be found here.\n* Chair (to contact for
  more information): jraim (#openstack-barbican @\n  Freenode)\n
RRULE:FREQ=WEEKLY
END:VEVENT
END:VCALENDAR

YAML会议文件

每次会议包括：

• project：项目的名称[必填]

• schedule：一系列的时间表，每个时间表包括：

  • time：UTC时间字符串[必填]

  • duration：会议的持续时间（分钟）；默认为60

  • start_date：首次会议的日期或之后。

    格式为YYYYMMDD，所有值必须为零填充。

  • day：会议发生的星期几[必填]

  • irc：会议举行的irc房间[必填]

  • frequency：会议的频繁发生[必填]

  • skip_dates：会议不会发生的日期集合

    • skip_date：跳过指定日期的会议。格式与start_date相同

    • reason：会议被跳过的原因注释

• chair：会议主席的姓名[必填]

• description：关于会议的段落描述[必填]

• agenda_url：会议议程页面的链接

• project_url：会议项目主页的链接

文件名应该是会议名称的小写、连字符版本，以.yaml结尾。例如，Keystone团队会议应保存为keystone-team-meeting.yaml。

YAML文件中列出的任何其他值也都可以在模板中使用，这使得构建会议议程页面或过去会议记录的链接变得容易。在模板文件中，使用meeting.extras.name来访问值。