README.md

caldav

This project is a CalDAV (RFC4791) client library for Python.

Features:

• create, modify calendar
• create, update and delete event
• search events by dates
• async support via caldav.aio module
• etc.

Quick Start

from caldav import get_davclient

with get_davclient() as client:
    principal = client.principal()
    calendars = principal.get_calendars()
    for cal in calendars:
        print(f"Calendar: {cal.name}")

Async API

For async/await support, use the caldav.aio module:

import asyncio
from caldav import aio

async def main():
    async with aio.get_async_davclient() as client:
        principal = await client.principal()
        calendars = await principal.get_calendars()
        for cal in calendars:
            print(f"Calendar: {cal.name}")

asyncio.run(main())

Documentation and other links

The user documentation (up-to-date with version 3.2) is embedded under docs/source - a rendered copy is available at https://caldav.readthedocs.io/

Other documentation:

• This file
• Changelog
• Contributors guide
• Contact information
• Code of Conduct
• Security Policy
• AI policy and AI disclaimer
• Apache License
• GPL license

There is also a directory docs/design containing lots of documents, mostly AI-generated, containing things like design decisions and other things that neither is deemed important enough to have a document on the root of the project nor deemed to be "user documentation".

The package is published at Pypi

HTTP Libraries

The sync client uses niquests by default (with fallback to requests). The async client uses httpx if installed, otherwise falls back to niquests. See HTTP Library Configuration for details.

Licences

The caldav library is dual-licensed under the GNU GENERAL PUBLIC LICENSE Version 3 or the Apache License 2.0.