Internet Calendaring and Scheduling (iCalendar) for Python
 
 
Go to file
Hugo Osvaldo Barrera d4c190866f Remove any syntax required for python < 3.8
find . -iname "*.py" -exec pyupgrade --py38-plus {} \;
2022-08-15 09:58:40 +02:00
.github/workflows Merge pull request #366 from collective/maurits-require-python38 2022-08-15 09:34:43 +02:00
docs Remove any syntax required for python < 3.8 2022-08-15 09:58:40 +02:00
src/icalendar Remove any syntax required for python < 3.8 2022-08-15 09:58:40 +02:00
.gitignore Use GitHub Actions. 2021-11-22 22:23:59 +01:00
.readthedocs.yml Add a RTD config file 2019-05-14 09:59:19 -07:00
CHANGES.rst Require Python 3.8. 2022-08-13 14:41:37 +02:00
CONTRIBUTING.rst link the Installation Section where people look for contributing 2022-08-07 22:10:27 +01:00
LICENSE.rst Clean up trailing and leading white space throughout project (#247) 2017-10-23 14:15:27 +02:00
MANIFEST.in Exclude editor backup files from egg distributions. Fixes #144. 2014-07-22 12:10:27 +02:00
README.rst Merge pull request #365 from niccokunzmann/patch-2 2022-08-13 14:09:48 +02:00
bootstrap.py Drop support for Python 2.6 and 3.3 2017-11-07 03:44:09 -08:00
buildout.cfg Whitespaces cleanup 2014-08-26 00:55:26 +02:00
requirements_docs.txt use sphinx_rdt_theme and document how to generate docs 2014-11-20 13:14:45 +01:00
setup.cfg check-manifest 2020-03-21 01:55:15 +01:00
setup.py Remove any syntax required for python < 3.8 2022-08-15 09:58:40 +02:00
tox.ini Require Python 3.8. 2022-08-13 14:41:37 +02:00

README.rst

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

The `icalendar`_ package is a `RFC 5545`_ compatible parser/generator for iCalendar
files.

----

:Homepage: https://icalendar.readthedocs.io
:Code: https://github.com/collective/icalendar
:Mailing list: https://github.com/collective/icalendar/issues
:Dependencies: `python-dateutil`_ and `pytz`_.
:Compatible with: Python 2.7 and 3.4+
:License: `BSD`_

----

.. 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

.. image:: https://github.com/collective/icalendar/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/collective/icalendar/actions/workflows/tests.yml
    :alt: GitHub Actions build status for master

.. image:: https://github.com/collective/icalendar/actions/workflows/tests.yml/badge.svg?branch=4.x
    :target: https://github.com/collective/icalendar/actions/workflows/tests.yml
    :alt: GitHub Actions build status for 4.x

.. _`icalendar`: https://pypi.org/project/icalendar/
.. _`RFC 5545`: https://www.ietf.org/rfc/rfc5545.txt
.. _`python-dateutil`: https://github.com/dateutil/dateutil/
.. _`pytz`: https://pypi.org/project/pytz/
.. _`BSD`: https://github.com/collective/icalendar/issues/2


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.
* `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.
* `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).