No Description

Jakub Valenta 1ffa6d1dcd alarm: Ignore param RELATED in TRIGGER 5 months ago
dev 54ca7761c4 Remove prepare-commit-msg 8 months ago
doc 6c82958b42 Update documentation 8 months ago
ics 1ffa6d1dcd alarm: Ignore param RELATED in TRIGGER 5 months ago
logo 30cee4b046 Add the ics.py logo and it's sources 4 years ago
tests bd918ec745 Fix off-by-one error on dtent for all-day events. 8 months ago
.coveragerc 80417cd271 [new] Omit tools.py from coverage 5 years ago
.gitignore 600506508f Update README and .gitignore (#140) 8 months ago
.travis.yml b847e43727 Start removal of python2 code 1 year ago
AUTHORS.rst b49ad6a9de Improve TRIGGER DURATION parsing logic (#148) 8 months ago
CHANGELOG.rst bd918ec745 Fix off-by-one error on dtent for all-day events. 8 months ago
CONTRIBUTING.rst 6c82958b42 Update documentation 8 months ago
LICENSE b36fffdf19 Update LICENSE so that Github regocnizes it 1 year ago
MANIFEST.in 06409a942a slight fixes 5 years ago
README.rst 600506508f Update README and .gitignore (#140) 8 months ago
meta.py 83211c933f Fix broken install 5 years ago
requirements.txt fb7da6c1c1 Apply patch from #77 (#151) 8 months ago
setup.cfg 3bbde327d7 Misc fixes 1 year ago
setup.py 1a612fb546 setup.py: Read requirements from files 8 months ago

README.rst

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

`Original repository `_ (GitHub) - `Bugtracker and issues `_ (GitHub) - `PyPi package `_ (ics) - `Documentation `_ (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 `_ 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
# []
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.

* `Quickstart `_
* `API `_
* `About `_


Contribute
----------

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


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

.. code-block:: bash

# setup virtual environment
$ sudo pip install virtualenv
$ virtualenv ve
$ source ve/bin/activate

# 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 `_
* `Vulgarised RFC `_

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