icalendar

Internet Calendaring and Scheduling (iCalendar) for Python

Go to file

Johannes Raggam e4c7e0f28a Merge remote-tracking branch 'nikolaeff/master'		2012-03-19 21:33:53 +01:00
docs	update changelog with recent changes	2012-03-19 18:14:10 +01:00
src/icalendar	Merge remote-tracking branch 'nikolaeff/master'	2012-03-19 21:33:53 +01:00
.gitignore	Preparing for 2.2 release	2011-08-24 23:18:36 +02:00
MANIFEST.in	adding tests back in, otherwise tox is not happy also you want to have tests in the package since you want to be sure everything is working in your env	2012-01-09 19:46:53 +01:00
README.rst	* For all TZID parameters in DATE-TIME properties, use timezone identifiers	2012-03-01 22:48:15 +01:00
TODO.txt	one more todo	2012-03-01 23:12:46 +01:00
__init__.py	Easy way to install this into Zope, as a Zope product. This will make	2005-04-04 16:50:12 +00:00
setup.py	changelog entries for last two commits. prepare release	2012-03-19 13:38:06 +01:00
tox.ini	restore tox environment for all major python versions	2012-03-19 17:34:12 +01:00

README.rst

==========================================================
Internet Calendaring and Scheduling (iCalendar) for Python
==========================================================

The `icalendar`_ package is a parser/generator of iCalendar files for use
with Python.

----

    :Code: http://github.com/collective/icalendar
    :Mailing list: http://github.com/collective/icalendar/issues
    :Dependencies: Since version 3.0 we depend on `pytz`_.
    :Tested with: Python 2.4 - 2.7
    :License: `BSD`_

----

Changes in version 3.0
======================

API Change
----------

Since version we unified to icalendar de/serialization API to use only to_ical
(for writing an ical string from the internal representation) and from_ical
(for parsing an ical string into the internal representation).

to_ical is now used instead of the methods ical, string, as_string and instead
of string casting via __str__ and str.

from_ical is now used instead of from_string.

This change is a requirement for future Python 3 compatibility. Please update
your code to reflect to the new API.

Timezone support
----------------

Timezones are now fully supported in icalendar for serialization and
deserialization. We use the pytz library for timezone components of datetime
instances. The timezone identifiers must be valid pytz respectively Olson
database timezone identifiers. This can be a problem for 'GMT' identifiers,
which are not defined in the Olson database.

Instead of the own UTC tzinfo implementation we use pytz UTC tzinfo object now.



About this fork which is not a fork anymore
===========================================

Aim of this fork (not fork anymore, read further) was to bring this package up
to date with latest icalendar `RFC`_ specification as part of
`plone.app.event`_ project which goal is to bring recurrent evens to `Plone`_.

After some thoughts we (Plone developers involved with `plone.app.event`_) send
a suggestion to icalendar-dev@codespeak.net to take over mainaining of
`icalendar`_. Nobody object and since version 2.2 we are back to development.


.. _`icalendar`: http://pypi.python.org/pypi/icalendar
.. _`plone.app.event`: http://github.com/collective/plone.app.event
.. _`Plone`: http://plone.org
.. _`pytz`: http://pypi.python.org/pypi/pytz
.. _`RFC`: http://www.ietf.org/rfc/rfc5545.txt
.. _`BSD`: https://github.com/collective/icalendar/issues/2