Skip to main content

CalDAV Server Checker - checking a CalDAV server for compatibility issues

Project description

caldav-server-tester

A command-line tool that probes a CalDAV server and reports which features and RFC requirements it supports, which ones it handles quirky, and which ones it gets wrong.

It is a companion to the caldav Python client library and produces output that is compatible with that library's compatibility_hints.py feature-flag system.

Status: alpha / pre-1.0. The checks are useful today, but the interface may change before the 1.0 release.

What it checks

  • Calendar creation and deletion (MKCALENDAR)
  • Saving and loading events, tasks, and journals
  • Time-range, text, alarm, and recurrence searches (RFC 4791)
  • Case sensitivity and substring matching in text searches
  • Sync-collection reports (RFC 6578)
  • Free-busy queries
  • Principal discovery (RFC 5397)
  • Duplicate UID handling across calendars
  • Timezone support in events

For full usage information, including all CLI options and output formats, see USAGE.md.

Installation

make install

(This auto-detects uv, pipx, or pip and does the right thing.)

Quick example

caldav-server-tester --caldav-url https://example.com/dav \
                     --caldav-username alice \
                     --caldav-password secret

See USAGE.md for details on output formats (--format json/yaml/hints), the --diff flag, running individual checks, and safety considerations.

Background

The caldav client library accumulated a large set of compatibility flags to work around differences between CalDAV server implementations. Every server deviates from the RFC in at least some way — some silently ignore unsupported features, some return errors, some return wrong data.

This tool was created to make it easy to discover and document those deviations without having to run the full caldav test suite and interpret failures manually. It can also alert you when a previously flagged problem has been fixed in a newer server version.

Vocabulary

The project is called caldav-server-tester, but internally the word test is reserved for code under the tests/ directory. Code that probes server capability is called a check.

License

AGPL-3.0-or-later

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_server_tester-1.0.1.tar.gz (70.4 kB view details)

Uploaded Source

Built Distribution

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

caldav_server_tester-1.0.1-py3-none-any.whl (40.0 kB view details)

Uploaded Python 3

File details

Details for the file caldav_server_tester-1.0.1.tar.gz.

File metadata

  • Download URL: caldav_server_tester-1.0.1.tar.gz
  • Upload date:
  • Size: 70.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for caldav_server_tester-1.0.1.tar.gz
Algorithm Hash digest
SHA256 56f9f5842fac8f9cffe62182e41f9c24eb9ba5db8d9eb91bc6bbf1a2844dd62a
MD5 a159cb1672b3fe10728b7b55357121b1
BLAKE2b-256 6cea5aadebaa0e3c8ac376613fe31b450281111cfbd91f7ac38df6a4618518b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for caldav_server_tester-1.0.1.tar.gz:

Publisher: publish.yaml on python-caldav/caldav-server-tester

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file caldav_server_tester-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for caldav_server_tester-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1440f4c59d5dbacffd5bdf06d167840e3af7b37e4cd9d4549a8cb1768ce68f72
MD5 a0ccc210f28ccf4a5c272e5ebe07af26
BLAKE2b-256 307cc8f284148942db0304fe8e5409d83640dc6678425053e803948d51e54d91

See more details on using hashes here.

Provenance

The following attestation bundles were made for caldav_server_tester-1.0.1-py3-none-any.whl:

Publisher: publish.yaml on python-caldav/caldav-server-tester

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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