Skip to main content

CalDAV (RFC4791) client library

Project description

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caldav-3.2.0.tar.gz (10.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

caldav-3.2.0-py3-none-any.whl (214.8 kB view details)

Uploaded Python 3

File details

Details for the file caldav-3.2.0.tar.gz.

File metadata

  • Download URL: caldav-3.2.0.tar.gz
  • Upload date:
  • Size: 10.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for caldav-3.2.0.tar.gz
Algorithm Hash digest
SHA256 d4df2c73843162af2fe7d324149830de8903690bfa094244029481d9bba320d0
MD5 7f562b042f7ba4e29e7600b629c26f78
BLAKE2b-256 7661c1e8bc2fe9c2dd63d95b0f1bca382541ba6d6ba631b1ad0a4f97d79ab104

See more details on using hashes here.

File details

Details for the file caldav-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: caldav-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 214.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for caldav-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39361f460a96599b8e4efbbdd711382adb1bbe8fc278eac4650f23cb6155eca5
MD5 79dd9970d44145e35f443f9177c2706a
BLAKE2b-256 8b66c607905a5c588d8a1315b7c496483eb88680e0bda40066697506f4db8413

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page