2011-08-17 21:40:23 +00:00
|
|
|
==========================================================
|
|
|
|
Internet Calendaring and Scheduling (iCalendar) for Python
|
|
|
|
==========================================================
|
|
|
|
|
|
|
|
The `icalendar`_ package is a parser/generator of iCalendar files for use
|
|
|
|
with Python.
|
|
|
|
|
2011-08-18 01:57:17 +00:00
|
|
|
----
|
|
|
|
|
2017-06-25 02:54:04 +00:00
|
|
|
:Homepage: https://icalendar.readthedocs.io
|
|
|
|
:Code: https://github.com/collective/icalendar
|
|
|
|
:Mailing list: https://github.com/collective/icalendar/issues
|
2017-06-19 17:46:34 +00:00
|
|
|
:Dependencies: `python-dateutil`_ and `pytz`_.
|
|
|
|
:Compatible with: Python 2.6, 2.7 and 3.3+
|
|
|
|
:License: `BSD`_
|
2011-08-18 01:57:17 +00:00
|
|
|
|
|
|
|
----
|
2011-08-17 21:40:23 +00:00
|
|
|
|
2012-08-23 11:45:16 +00:00
|
|
|
|
2014-06-03 15:49:09 +00:00
|
|
|
.. image:: https://travis-ci.org/collective/icalendar.svg?branch=master
|
|
|
|
:target: https://travis-ci.org/collective/icalendar
|
|
|
|
|
|
|
|
|
2014-01-06 15:17:26 +00:00
|
|
|
Roadmap
|
|
|
|
=======
|
|
|
|
|
|
|
|
- 4.0: API refactoring
|
|
|
|
|
|
|
|
|
2012-03-01 13:36:17 +00:00
|
|
|
Changes in version 3.0
|
|
|
|
======================
|
|
|
|
|
|
|
|
API Change
|
|
|
|
----------
|
2012-02-29 11:30:11 +00:00
|
|
|
|
2014-11-12 13:25:19 +00:00
|
|
|
Since version 3.0 the icalendar de/serialization API is unified to use only to_ical
|
2012-02-29 11:30:11 +00:00
|
|
|
(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.
|
|
|
|
|
2012-03-01 13:36:17 +00:00
|
|
|
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.
|
|
|
|
|
2017-06-25 02:54:04 +00:00
|
|
|
Instead of our own UTC tzinfo implementation, we use pytz UTC tzinfo object now.
|
2012-03-01 13:36:17 +00:00
|
|
|
|
2011-08-17 21:40:23 +00:00
|
|
|
|
2011-08-24 21:18:36 +00:00
|
|
|
About this fork which is not a fork anymore
|
|
|
|
===========================================
|
2011-08-17 21:45:55 +00:00
|
|
|
|
2014-11-12 13:25:19 +00:00
|
|
|
The aim of this fork (not fork anymore, read further) was to bring this package
|
2017-06-25 02:54:04 +00:00
|
|
|
up to date with latest icalendar `RFC`_ specification, as part of the
|
|
|
|
`plone.app.event`_ project whose goal is to bring recurrent events to `Plone`_.
|
2011-08-17 21:40:23 +00:00
|
|
|
|
2017-06-25 02:54:04 +00:00
|
|
|
After some thoughts we (Plone developers involved with `plone.app.event`_) sent
|
|
|
|
a suggestion to icalendar-dev@codespeak.net to take over maintenance of
|
2014-11-12 13:25:19 +00:00
|
|
|
`icalendar`_. Nobody objected and since version 2.2 we are back to development.
|
2011-08-18 01:57:17 +00:00
|
|
|
|
2017-06-25 02:54:04 +00:00
|
|
|
.. _`icalendar`: https://pypi.python.org/pypi/icalendar
|
|
|
|
.. _`plone.app.event`: https://github.com/plone/plone.app.event
|
|
|
|
.. _`Plone`: https://plone.org
|
2017-01-24 01:59:01 +00:00
|
|
|
.. _`python-dateutil`: https://github.com/dateutil/dateutil/
|
2017-06-25 02:54:04 +00:00
|
|
|
.. _`pytz`: https://pypi.python.org/pypi/pytz
|
|
|
|
.. _`RFC`: https://www.ietf.org/rfc/rfc5545.txt
|
2012-02-27 09:22:43 +00:00
|
|
|
.. _`BSD`: https://github.com/collective/icalendar/issues/2
|
2012-08-23 12:05:26 +00:00
|
|
|
|
|
|
|
|
|
|
|
Test Coverage Report
|
|
|
|
====================
|
|
|
|
|
|
|
|
Output from coverage test::
|
|
|
|
|
2015-03-24 11:55:29 +00:00
|
|
|
Name Stmts Miss Cover
|
|
|
|
--------------------------------------------------
|
|
|
|
src/icalendar/__init__ 4 0 100%
|
|
|
|
src/icalendar/cal 312 7 98%
|
|
|
|
src/icalendar/caselessdict 65 7 89%
|
|
|
|
src/icalendar/compat 1 0 100%
|
|
|
|
src/icalendar/parser 193 5 97%
|
|
|
|
src/icalendar/parser_tools 20 0 100%
|
|
|
|
src/icalendar/prop 540 62 89%
|
|
|
|
src/icalendar/timezone_cache 1 0 100%
|
|
|
|
src/icalendar/tools 16 0 100%
|
|
|
|
--------------------------------------------------
|
|
|
|
TOTAL 1152 81 93%
|