CalDAV Server Checker - checking a CalDAV server for compatibility issues

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tobixen from gravatar.com tobixen

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU Affero General Public License v3 or later (AGPLv3+) (AGPL-3.0-or-later)
  • Author: Tobias Brox
  • Tags caldav , calendar , compatibility , server , testing
  • Requires: Python >=3.10
  • Provides-Extra: dev
Classifiers
Report project as malware

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. See https://caldav.readthedocs.io/latest/configfile.html#testing-server-compatibility on how to use it for configuring your server compatibility in a formt that the libary can read.

What it checks

The full list is currently maintained in the CalDAV library, https://github.com/python-caldav/caldav/blob/master/caldav/compatibility_hints.py - the checks includes:

  • 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. Hopefully.)

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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tobixen from gravatar.com tobixen

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU Affero General Public License v3 or later (AGPLv3+) (AGPL-3.0-or-later)
  • Author: Tobias Brox
  • Tags caldav , calendar , compatibility , server , testing
  • Requires: Python >=3.10
  • Provides-Extra: dev
Classifiers

Release history Release notifications | RSS feed

This version

1.1.0

1.0.1

1.0.0

0.2.2

0.1.0

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.1.0.tar.gz (80.5 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.1.0-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for caldav_server_tester-1.1.0.tar.gz
Algorithm Hash digest
SHA256 04a3881080db24cbfb836d2e532095876672840d92d78c4f5ac4f63c0a50af91
MD5 d3f0dfa9470f1698842a98aaa0e7648a
BLAKE2b-256 1de785f4f5ad24813b08f0d0ac9098fd1ff728f485c191ef4c60be32b9277447

See more details on using hashes here.

Provenance

The following attestation bundles were made for caldav_server_tester-1.1.0.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.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for caldav_server_tester-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00b526f92ab498038434da907bd2cd4a5bc127fa39a8225dc014e5f669c2b4fb
MD5 062c6fafc29bbf2a03984f16252da06a
BLAKE2b-256 182269bd017ffb9c86c9aa7d4b2cd7e0890d824d7f9e358a85f4e621527d7dcb

See more details on using hashes here.

Provenance

The following attestation bundles were made for caldav_server_tester-1.1.0-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