Skip to main content

Python icalendar (rfc5545) parser

Project description

Original repository (GitHub) - Bugtracker and issues (GitHub) - PyPi package (ics) - Documentation (Read The Docs).

https://travis-ci.org/C4ptainCrunch/ics.py.png?branch=master Coverage Apache 2 License

Ics.py is a pythonic and easy iCalendar library. It’s goals are to read and write ics data in a developer friendly way.

iCalendar is a widely-used and useful format but not user friendly. Ics.py is there to give you the ability of creating and reading this format without any knowledge of it.

It should be able to parse every calendar that respects the rfc5545 and maybe some more… It also outputs rfc compliant calendars.

iCalendar (file extension .ics) is used by Sunbird, Google Calendar, Apple Calendar, Android…

Ics.py is available for Python>=2.7 and Python>=3.3 and is Apache2 Licensed.

Note : it is highly likely that Python 2 support will be dropped before the 1.0 release.

Quickstart

$ pip install ics
>>> from ics import Calendar, Event
>>> c = Calendar()
>>> e = Event()
>>> e.name = "My cool event"
>>> e.begin = '20140101 00:00:00'
>>> c.events.append(e)
>>> c.events
[<Event 'My cool event' begin:2014-01-01 00:00:00 end:2014-01-01 00:00:01>]
>>> with open('my.ics', 'w') as my_file:
>>>     my_file.writelines(c)
>>> # and it's done !

More examples are available in the documentation.

Documentation

All the documentation is hosted on readthedocs.org and is updated automatically at every commit.

Contribute

Contribution are welcome of course! For more information, see contributing.

Testing & Docs

# tests
$ pip install -r requirements.txt
$ pip install -r dev/requirements-test.txt
$ python setup.py test

# tests coverage
$ pip install -r requirements.txt
$ pip install -r dev/requirements-test.txt
$ python setup.py test
$ coverage html
$ firefox htmlcov/index.html

# docs
$ pip install -r requirements.txt
$ pip install -r dev/requirements-doc.txt
$ cd doc
$ make html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ics-0.4-py2.7.egg (23.0 kB) Copy SHA256 hash SHA256 Egg 2.7 May 18, 2018
ics-0.4-py2.py3-none-any.whl (27.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 18, 2018
ics-0.4-py3.6.egg (53.7 kB) Copy SHA256 hash SHA256 Egg 3.6 May 18, 2018
ics-0.4.tar.gz (50.9 kB) Copy SHA256 hash SHA256 Source None May 18, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page