A module which unfolds ICalendar events.
Project description
ICal has some complexity to it: Events can be repeated, removed from the feed and edited later on. This tool takes care of these circumstances.
Let’s put our expertise together and build a tool that can solve this!
day light saving time (DONE)
recurring events (DONE)
recurring events with edits (DONE)
recurring events where events are omitted (DONE)
recurring events events where the edit took place later (DONE)
normal events (DONE)
recurrence of dates but not hours, minutes, and smaller (DONE)
endless recurrence (DONE)
ending recurrence (DONE)
events with start date and no end date (DONE)
events with start as date and start as datetime (DONE)
RRULE (DONE)
RDATE (DONE)
DURATION (DONE)
EXDATE (DONE)
Not included:
EXRULE (deprecated), see 8.3.2. Properties Registry
Installation
pip install python-recurring-ical-eventsExample
import icalendar
import recurring_ical_events
import urllib.request
start_date = (2019, 3, 5)
end_date = (2019, 4, 1)
url = "http://tinyurl.com/y24m3r8f"
ical_string = urllib.request.urlopen(url).read()
calendar = icalendar.Calendar.from_ical(ical_string)
events = recurring_ical_events.of(calendar).between(start_date, end_date)
for event in events:
start = event["DTSTART"].dt
duration = event["DTEND"].dt - event["DTSTART"].dt
print("start {} duration {}".format(start, duration))Output:
start 2019-03-18 04:00:00+01:00 duration 1:00:00
start 2019-03-20 04:00:00+01:00 duration 1:00:00
start 2019-03-19 04:00:00+01:00 duration 1:00:00
start 2019-03-07 02:00:00+01:00 duration 1:00:00
start 2019-03-08 01:00:00+01:00 duration 2:00:00
start 2019-03-09 03:00:00+01:00 duration 0:30:00
start 2019-03-10 duration 1 day, 0:00:00Usage
The icalendar module is responsible for parsing and converting calendars. The recurring_ical_events module uses such a calendar and creates all repetitions of its events within a time span.
To import this module, write
import recurring_ical_eventsThere are several methods you can use to unfold repeating events, such as at(a_time) and between(a_start, an_end).
at(a_date)
You can get all events which take place at a_date. A date can be a year, e.g. 2023, a month of a year e.g. January in 2023 (2023, 1), a day of a certain month e.g. (2023, 1, 1), an hour e.g. (2023, 1, 1, 0), a minute e.g. (2023, 1, 1, 0, 0), or second as well as a datetime.date object and datetime.datetime.
The start and end are inclusive. As an example: if an event is longer than one day it is still included if it takes place at a_date.
a_date = 2023 # a year
a_date = (2023, 1) # January in 2023
a_date = (2023, 1, 1) # the 1st of January in 2023
a_date = (2023, 1, 1, 0) # the first hour of the year 2023
a_date = (2023, 1, 1, 0, 0) # the first minute in 2023
a_date = datetime.date(2023) # the first day in 2023
a_date = datetime.date(2023, 1, 1) # the first day in 2023
events = recurring_ical_events.of(an_icalendar_object).at(a_date)The resulting events are a list of icalendar events, see below.
between(start, end)
between(start, end) returns all events happening between a start and an end time. Both arguments can be datetime.datetime, datetime.date, tuples of numbers passed as arguments to datetime.datetime or strings in the form of %Y%m%d (yyyymmdd) and %Y%m%dT%H%M%SZ (yyyymmddThhmmssZ). For examples, see at(a_date) above.
events = recurring_ical_events.of(an_icalendar_object).between(start, end)The resulting events are in a list, see below.
events as list
The result of both between(start, end) and at(a_date) is a list of icalendar events. By default, all attributes of the event with repetitions are copied, like UID and SUMMARY. However, these attributes may differ from the source event:
DTSTART which is the start of the event instance.
DTEND which is the end of the event instance.
RDATE, EXDATE, RRULE are the rules to create event repetitions. If they are included is undefined. Future requirements may remove them. If you like to have them included, please write a test or open an issue.
Development
- Optional: Install virtualenv and Python3 and create a virtual environment.
virtualenv -p python3 ENV source ENV/bin/activate
- Install the packages.
pip install -r requirements.txt -r test-requirements.txt
- Run the tests
pytest
To release new versions, edit setup.py, the __version__ variable and run
python3 setup.py tag_and_deployTesting
This project’s development is driven by tests. You can view the tests in the test folder If you have a calendar ICS file for which this library does not generate the desired output, you can add it to the test/calendars folder and write tests for what you expect. If you like, open an issue first, e.g. to discuss the changes and how to go about it.
Research
https://github.com/oberron/annum - https://stackoverflow.com/questions/28829261/python-ical-get-events-for-a-day-including-recurring-ones#28829401
https://stackoverflow.com/questions/20268204/ical-get-date-from-recurring-event-by-rrule-and-dtstart
https://stackoverflow.com/questions/46471852/ical-parsing-reoccuring-events-in-python
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for recurring_ical_events-0.1.6b0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d52e0bf0946652af93e2c9bc6a1e893584687b5227e6d9d6e96a7a19b6fd6d52 |
|
| MD5 | ac38de509f0dbd4a163ac5760358b331 |
|
| BLAKE2b-256 | 12fb5e7a41bf4a6a5a623cdc5de07d8f48d6fbce61a3b547163543f4ae7ac0d0 |
