README

   1 Flexible aggregation for iCalendar feeds (:RFC:`5545`).
   2
   3 The iCalender standard provides a common format for exchanging
   4 calendar information.  This project aims to provide a library with a
   5 clean API for aggregating and processing iCalendar feeds.  What you do
   6 with that processed information is up to you.
   7
   8 There are a number of existing aggregators, ranging from the
   9 closed-source `Google Calendar`_ to the open-source elmcity_ and
  10 Calagator_.  However, I want a library that can work as an iCalendar
  11 version of feedparser_, and `code for a web-frontend`__ is just dead
  12 weight.
  13
  14 __ `elmcity code`_
  15
  16 Installation
  17 ============
  18
  19 Pycalendar is packaged with distutils_, so you can install it in all
  20 the usual ways.  Any of the following should work::
  21
  22   $ python setup.py install
  23   $ pip install pycalendar
  24
  25 There are no dependencies outside Python's standard library.
  26
  27 Testing
  28 =======
  29
  30 Test with nose_::
  31
  32   $ nosetests --with-doctest --doctest-tests pycalendar
  33
  34 There is also a example aggregation script that prints aggregate feed
  35 to stdout and geographic positions to stderr.  Run it with::
  36
  37   $ PYTHONPATH=. test/aggregate.py
  38
  39
  40 .. _Calagator: http://calagator.org/
  41 .. _distutils: http://docs.python.org/3/distutils/
  42 .. _elmcity: http://elmcity.cloudapp.net/
  43 .. _elmcity code: https://github.com/judell/elmcity
  44 .. _feedparser: https://pypi.python.org/pypi/feedparser/
  45 .. _Google Calendar: https://support.google.com/calendar/
  46 .. _nose: https://nose.readthedocs.org/en/latest/