Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.51 KB

README.md

File metadata and controls

66 lines (55 loc) · 2.51 KB
Raw

ICS to CalDAV synchronisation

Downloads a calendar in ICS format and uploads it to a CalDAV server, regularly. Your employee, school, or whoever shares a calendar as a link to an ICS file and you'd like to have it on another CalDAV server? Look no further.

Standalone usage

Install the script with pip install . and run ics_caldav_sync script which should be on your PATH now.

There also exist Dockerfile and docker-compose.yml files so you can run it on your Docker server.

Set the settings as environment variables:

  • REMOTE_URL (str): ICS file URL.
  • LOCAL_URL (str): CalDAV URL.
  • LOCAL_CALENDAR_NAME (str): The name of your CalDAV calendar.
  • LOCAL_USERNAME (str): CalDAV username.
  • LOCAL_PASSWORD (str): CalDAV password.
  • REMOTE_USERNAME (str, optional): ICS host username.
  • REMOTE_PASSWORD (str, optional): ICS host password.
  • TIMEZONE (str, optional): Override events timezone. (Example timezones: Utc, Europe/Warsaw, Asia/Tokyo).
  • SYNC_EVERY (str): How often should the synchronisation occur? For example: 2 minutes, 1 hour. Synchronise once if empty.
  • DEBUG (bool, optional): Set to anything to print debugging messages. Please set this when reporting an error.
  • SYNC_ALL (bool, optional): If set, all events in the calendar will be synced. Otherwise, only the ones occuring in the future will be.
  • KEEP_LOCAL (bool, optional): Do not delete events on the CalDAV server that do not exist in the ICS file.

Library usage

This script can be also used as a library in your Python script using ICSToCalDAVSync class and its synchronise method.

    def ICSToCalDAVSync.__init__(
        self,
        *,
        remote_url: str,
        local_url: str,
        local_calendar_name: str,
        local_username: str,
        local_password: str,
        remote_username: str = "",
        remote_password: str = "",
        sync_all: bool = False,
        keep_local: bool = False,
        timezone: str = "",
    )

    def ICSToCalDavSync.synchronise(self):
        """
        The main function which:
        1) Pulls the events from the remote calendar,
        2) Saves them into the local calendar,
        3) Removes local events which are not in the remote any more.

        If sync_all is set, all events will be pulled. Otherwise, only
        the ones occuring after now will be.
        """

Rationale

In my case, my new shiny Bluetooth wristwatch, Casio Edifice ECB-10, did not support synchronisation with calendar subscriptions. And so this script was created.