caldav-tasks-api 1.8.0

A Python client for CalDAV task servers, with a CLI.

(Full documentation available at caldavtasksapi.readthedocs.io)

CalDAV-Tasks-API

A Python library and command-line interface (CLI) for interacting with CalDAV task lists (VTODOs). This project provides tools to connect to a CalDAV server, fetch task lists and tasks, create new tasks, and delete existing ones.

Table of Contents

• Motivation and Purpose
• Compatibility
• Features
• Installation
• Contributing
• Acknowledgements

Motivation and Purpose

This library was developed as a foundational component for integrating CalDAV task management with more advanced systems. The primary goal is to serve as a backbone for:

1. Synchronizing tasks from applications like the excellent Tasks.org Android app.
2. Enabling features such as smart task prioritization using ELO ranking, envisioned to work with a Litoy-like setup.
3. Making useful python objects with handy methods to manipulate caldav's tasks.
4. Making a CLI interface to manipulate tasks (secondary goal).

By providing a robust Python interface to CalDAV tasks, this project aims to bridge the gap between standard task management and custom, intelligent task processing workflows. The library is intentionally designed to be minimal, with few external dependencies, to ensure it is lightweight and easy to integrate.

Compatibility

The API has been primarily tested with Nextcloud Tasks. However, it is designed to be compatible with any CalDAV server that supports VTODO components.

Testers and feedback for other CalDAV server implementations (e.g., Baïkal, Radicale, Synology Calendar) are highly welcome!

Features

• Connect to CalDAV servers with optional Nextcloud-specific URL adjustments.
• Load task lists (calendars supporting VTODOs).
• Load tasks from specified lists, parsing standard iCalendar properties.
• Preserve and provide access to custom X- properties.
• Create, update, and delete tasks (VTODOs) on the server.
• Access parent and child task relationships (TaskData.parent_task and TaskData.child_tasks).
• Read-only mode for applications that need to prevent modifications.
• CLI with multiple commands: show summaries, list tasks, add tasks, and list available task lists.
• JSON output support for integration with other tools.
• Environment variable support for credentials and default settings.

Installation

The CalDAV Tasks API can be installed directly from PyPI:

uv pip install caldav-tasks-api

Alternatively, you can install from source:

1. Clone the repository:

   git clone <repository_url>
   cd caldav-tasks-api
   

2. Install dependencies (ensure you have python>=3.8):

   # Install the package and all dependencies:
   uv pip install .
   
   # For development with editable install:
   uv pip install -e .
   
   # For development with additional dev dependencies:
   uv pip install -e ".[dev]"
   

Configuration

The library supports configuration via environment variables:

• CALDAV_TASKS_API_URL: CalDAV server URL
• CALDAV_TASKS_API_USERNAME: CalDAV username
• CALDAV_TASKS_API_PASSWORD: CalDAV password
• CALDAV_TASKS_API_DEFAULT_LIST_UID: Default task list UID for operations
• CALDAV_TASKS_API_DEFAULT_PRIORITY: Default priority to use when creating tasks
• CALDAV_TASKS_API_LOG_LEVEL: Default log level, by default WARNING

Usage

Command Line Interface

The package provides several CLI commands:

# Show summary of all task lists and tasks
python -m caldav_tasks_api show-summary

# Show summary with JSON output
python -m caldav_tasks_api show-summary --json

# List available task lists
python -m caldav_tasks_api list-lists

# List latest tasks from a specific list (JSON output)
python -m caldav_tasks_api list-latest-tasks --list-uid <list-uid>

# List latest tasks as human-readable summaries, ordered as in tasks.org
python -m caldav_tasks_api list-latest-tasks --list-uid <list-uid> --simple

# Dump all the tasks of a list as VTODO format
python -m caldav_tasks_api dump-all-tasks --list-uid <list-uid>

# Add a new task
python -m caldav_tasks_api add-task --list-uid <list-uid> --summary "My new task"

# Add a task with additional properties
python -m caldav_tasks_api add-task \
  --list-uid <list-uid> \
  --summary "Important task" \
  --description "Task description" \
  --priority 5 \
  --due-date 20240315 \
  --tag urgent --tag work

All commands support --help for detailed options.

Python API

from caldav_tasks_api import TasksAPI
from caldav_tasks_api.utils.data import TaskData

# Initialize API (credentials from environment or parameters)
api = TasksAPI(
    url="https://your-server.com/remote.php/dav/",
    username="your-username", 
    password="your-password",
    # include_completed=False,  # True by default but loading ALL tasks can be slow
    # target_lists=["my frequent list"],  # set this to load only a subset of your calendars, faster
)

# Load all task lists and tasks
api.load_remote_data()

# Access task lists
for task_list in api.task_lists:
    print(f"List: {task_list.name} ({len(task_list.tasks)} tasks)")
    
    for task in task_list.tasks:
        print(f"  - {task.summary}")

# Create a new task
new_task = TaskData(
    summary="My new task",
    list_uid="your-list-uid",
    description="Task description",
    priority=5
)
created_task = api.add_task(new_task)

# Update a task
task = api.get_task_by_global_uid("task-uid")
if task:
    task.summary = "Updated task title"
    api.update_task(task)

Contributing

Contributions are welcome! If you'd like to contribute, please feel free to:

1. Open an issue to discuss a bug, feature request, or an idea.
2. Fork the repository and submit a pull request with your changes.

Please ensure your code follows the existing style and includes tests where appropriate.

Acknowledgements

This project was developed with the assistance of aider.chat, an AI pair programmer.