2011-08-17 21:40:23 +00:00
==========================================================
Internet Calendaring and Scheduling (iCalendar) for Python
==========================================================
2017-11-08 13:00:36 +00:00
The `icalendar`_ package is a `RFC 5545`_ compatible parser/generator for iCalendar
files.
2011-08-17 21:40:23 +00:00
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`_.
2017-10-22 21:07:19 +00:00
:Compatible with: Python 2.7 and 3.4+
2017-06-19 17:46:34 +00:00
:License: `BSD`_
2011-08-18 01:57:17 +00:00
----
2011-08-17 21:40:23 +00:00
2022-08-07 22:55:02 +00:00
.. image :: https://badge.fury.io/py/icalendar.svg
:target: https://pypi.org/project/icalendar/
:alt: Python Package Version on PyPI
.. image :: https://img.shields.io/pypi/dm/icalendar.svg
:target: https://pypi.org/project/icalendar/#files
:alt: Downloads from PyPI
2014-06-03 15:49:09 +00:00
2022-08-13 20:36:12 +00:00
.. image :: https://img.shields.io/github/workflow/status/collective/icalendar/tests/master?label=master&logo=github
:target: https://github.com/collective/icalendar/actions/workflows/tests.yml?query=branch%3Amaster
2022-08-07 21:50:37 +00:00
:alt: GitHub Actions build status for master
2022-08-13 12:04:13 +00:00
2022-08-13 20:36:12 +00:00
.. image :: https://img.shields.io/github/workflow/status/collective/icalendar/tests/4.x?label=4.x&logo=github
:target: https://github.com/collective/icalendar/actions/workflows/tests.yml?query=branch%3A4.x++
2022-08-07 21:50:37 +00:00
:alt: GitHub Actions build status for 4.x
2014-06-03 15:49:09 +00:00
2018-04-26 13:16:27 +00:00
.. _`icalendar`: https://pypi.org/project/icalendar/
2017-11-08 13:00:36 +00:00
.. _`RFC 5545`: https://www.ietf.org/rfc/rfc5545.txt
2017-01-24 01:59:01 +00:00
.. _`python-dateutil`: https://github.com/dateutil/dateutil/
2018-04-26 13:16:27 +00:00
.. _`pytz`: https://pypi.org/project/pytz/
2012-02-27 09:22:43 +00:00
.. _`BSD`: https://github.com/collective/icalendar/issues/2
2018-01-29 19:09:22 +00:00
2022-08-13 21:03:40 +00:00
Versions and Compatibility
--------------------------
`` icalendar `` is a critical project used by many. It has been there for a long time and maintaining
long-term compatibility with projects conflicts partially with providing and using the features that
the latest Python versions bring.
Since we pour more `effort into maintaining and developing icalendar <https://github.com/collective/icalendar/discussions/360> `__ ,
we split the project into two:
2022-08-19 13:45:18 +00:00
- `Branch 4.x <https://github.com/collective/icalendar/tree/4.x> `__ with maximum compatibility to Python versions `` 2.7 `` and `` 3.4+ `` , `` PyPy2 `` and `` PyPy3 `` .
- `Branch master <https://github.com/collective/icalendar/> `__ with the compatibility to Python versions `` 3.7+ `` and `` PyPy3 `` .
2022-08-13 21:03:40 +00:00
We expect the `` master `` branch with versions `` 5+ `` receive the latest updates and features,
and the `` 4.x `` branch the subset of security and bug fixes only.
2022-08-23 03:02:25 +00:00
We recommend migrating to later Python versions and also providing feedback if you depend on the `` 4.x `` features.
2018-01-29 19:09:22 +00:00
Related projects
================
* `icalevents <https://github.com/irgangla/icalevents> `_ . It is built on top of icalendar and allows you to query iCal files and get the events happening on specific dates. It manages recurrent events as well.
2022-06-23 10:19:55 +00:00
* `recurring-ical-events <https://pypi.org/project/recurring-ical-events/> `_ . Library to query an `` ICalendar `` object for events happening at a certain date or within a certain time.
2022-06-23 10:29:01 +00:00
* `x-wr-timezone <https://pypi.org/project/x-wr-timezone/> `_ . Library to make `` ICalendar `` objects and files using the non-standard `` X-WR-TIMEZONE `` compliant with the standard (RFC 5545).