Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ics-py/ics-py

Pythonic and easy iCalendar library (rfc5545)
https://github.com/ics-py/ics-py

calendar event ical icalendar ics parser python rfc5545

Last synced: about 9 hours ago
JSON representation

Pythonic and easy iCalendar library (rfc5545)

Awesome Lists containing this project

README 

        
ics.py `0.8.0.dev0` : iCalendar for Humans

==========================================



`Original repository `_ (GitHub) -

`Bugtracker and issues `_ (GitHub) -

`PyPi package `_ (ics) -

`Documentation `_ (Read The Docs).



.. image:: https://img.shields.io/pypi/l/ics

    :target: https://pypi.python.org/pypi/ics/

    :alt: Apache 2 License



.. pull-quote::

    You are viewing the README for the current development version on the `main` branch.

    To get the README for the current release, check out its `PyPi page `_ and the `0.7 branch `_ of this repo.

    

    To install the current development version, you can either use the following pip command or use a (slightly older) `alpha release from PyPi `_.



    .. code-block:: bash



        pip install git+https://github.com/ics-py/ics-py.git



Ics.py is a pythonic and easy iCalendar library.

Its 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 Google Calendar,

Apple Calendar, Android and many more.



Ics.py is available for Python 3.8, 3.9, 3.10, 3.11, 3.12 and is Apache2 Licensed.



Quickstart

----------



.. code-block:: bash



    $ pip install ics



.. code-block:: python



 from datetime import datetime

 from ics import Calendar, Event



 c = Calendar()

 e = Event()

 e.summary = "My cool event"

 e.description = "A meaningful description"

 e.begin = datetime.fromisoformat("2022-06-06T12:05:23+02:00")

 e.end = datetime.fromisoformat("2022-06-06T13:05:23+02:00")

 c.events.append(e)

 c

 # Calendar(extra=Container('VCALENDAR', []), extra_params={}, version='2.0', prodid='ics.py 0.8.0.dev0 - http://git.io/lLljaA', scale=None, method=None, events=[Event(extra=Container('VEVENT', []), extra_params={}, timespan=EventTimespan(begin_time=datetime.datetime(2022, 6, 6, 12, 5, 23, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200))), end_time=None, duration=None, precision='second'), summary=None, uid='[email protected]', description=None, location=None, url=None, status=None, created=None, last_modified=None, dtstamp=datetime.datetime(2022, 6, 6, 19, 28, 14, 575558, tzinfo=Timezone.from_tzid('UTC')), alarms=[], attach=[], classification=None, transparent=None, organizer=None, geo=None, attendees=[], categories=[])], todos=[])

 with open("my.ics", "w", newline='') as f:

     f.write(c.serialize())



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 and how to setup, see

`contributing `_.



Links

-----

* `rfc5545 `_

* `Vulgarised RFC `_

* Alternative Libraries: `icalendar `_ and `ical `_



.. image:: http://i.imgur.com/KnSQg48.jpg

    :target: https://github.com/ics-py/ics-py

    :alt: Parse ALL the calendars!

    :align: center