ics-lancstimtab 0.5.dev0
Python icalendar (rfc5545) parser
License: Apache License, Version 2.0
Keywords: ics icalendar calendar event todo rfc5545 parser pythonic

Ics.py : iCalendar for Humans
=============================

`Original repository <https://github.com/C4ptainCrunch/ics.py>`_ (GitHub) - `Bugtracker and issues <https://github.com/C4ptainCrunch/ics.py/issues>`_ (GitHub) - `PyPi package <https://pypi.python.org/pypi/ics/>`_ (ics) - `Documentation <http://icspy.readthedocs.org/>`_ (Read The Docs).

.. image:: https://travis-ci.org/C4ptainCrunch/ics.py.png?branch=master
   :target: https://travis-ci.org/C4ptainCrunch/ics.py

.. image:: https://coveralls.io/repos/C4ptainCrunch/ics.py/badge.png
   :target: https://coveralls.io/r/C4ptainCrunch/ics.py
   :alt: Coverage

.. image:: https://img.shields.io/github/license/c4ptaincrunch/ics.py.svg
    :target: https://pypi.python.org/pypi/ics/
    :alt: 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 <http://tools.ietf.org/html/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>=3.4 and is Apache2 Licensed.



Quickstart
----------

.. code-block:: bash

    $ pip install ics



.. code-block:: python

    from ics import Calendar, Event
    c = Calendar()
    e = Event()
    e.name = "My cool event"
    e.begin = '20140101 00:00:00'
    c.events.add(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 <http://icspy.readthedocs.org/>`_.

Documentation
-------------

All the `documentation <http://icspy.readthedocs.org/>`_ is hosted on `readthedocs.org <http://readthedocs.org/>`_ and is updated automatically at every commit.

* `Quickstart <http://icspy.readthedocs.org/>`_
* `API <http://icspy.readthedocs.org/en/latest/api.html>`_
* `About <http://icspy.readthedocs.org/en/latest/about.html>`_


Contribute
----------

Contribution are welcome of course! For more information, see `contributing <https://github.com/C4ptainCrunch/ics.py/blob/master/CONTRIBUTING.rst>`_.


Testing & Docs
--------------

.. code-block:: bash

    # 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


Links
-----
* `rfc5545 <http://tools.ietf.org/html/rfc5545>`_
* `Vulgarised RFC <http://www.kanzaki.com/docs/ical/>`_

.. image:: http://i.imgur.com/KnSQg48.jpg
    :target: https://github.com/C4ptainCrunch/ics.py
    :alt: Parse ALL the calendars!
    :align: center