Usage

Credentials for the CalDAV server can be provided as arguments to the CLI or TasksAPI constructor, or via the following environment variables:

  • CALDAV_TASKS_API_URL: The full URL to your CalDAV server (e.g., https://cloud.example.com/remote.php/dav)

  • CALDAV_TASKS_API_USERNAME: Your CalDAV username.

  • CALDAV_TASKS_API_PASSWORD: Your CalDAV password.

Command-Line Interface (CLI)

The CLI provides a simple way to interact with your CalDAV tasks. After installation, you can use the CLI in two ways:

  1. Using the installed command (if installed via pip):

    caldav-tasks-api <command> [options]

  2. Using the module directly (if running from source):

    python -m caldav_tasks_api <command> [options]

Available Commands:

  • show_summary: Connects to the server, loads task lists and tasks, and prints a summary.

  • add-task: Adds a new task to a specified task list.

  • list-latest-tasks: Lists the most recently created, non-completed tasks.

  • list-lists: Prints a JSON list of task lists (name and UID).

Examples:

# Using command-line arguments for credentials (installed version)
caldav-tasks-api show_summary \
    --url "https://your.nextcloud.instance/remote.php/dav" \
    --username "your_user" \
    --password "your_password"

# Using environment variables (assuming they are set)
export CALDAV_TASKS_API_URL="https://your.nextcloud.instance/remote.php/dav"
export CALDAV_TASKS_API_USERNAME="your_user"
export CALDAV_TASKS_API_PASSWORD="your_password"
caldav-tasks-api show_summary

# Show summary for specific task lists and enable debug console
caldav-tasks-api show_summary --list "Personal" --list "Work Project" --debug

# Output results in JSON format (useful for scripting)
caldav-tasks-api show_summary --json > tasks_data.json

# Add a new task (using environment variables for credentials)
# Ensure CALDAV_TASKS_API_DEFAULT_LIST_UID is set or provide --list-uid
caldav-tasks-api add-task --summary "My new task from CLI"

# Add a more detailed task with various properties
caldav-tasks-api add-task \
    --summary "Complete project proposal" \
    --description "Include budget analysis and timeline" \
    --priority 5 \
    --due-date "20240315T170000Z" \
    --tag "work" \
    --tag "urgent" \
    --percent-complete 25 \
    --x-property "X-PROJECT-ID=PROJ-2024-001"

# List the latest 5 tasks from a specific list (output is JSON)
caldav-tasks-api list-latest-tasks --list-uid "your-list-uid-here" --limit 5 > latest_tasks.json

# List all available task lists (output is JSON)
caldav-tasks-api list-lists > all_lists.json

Common Options:

  • --url TEXT: CalDAV server URL (or set CALDAV_TASKS_API_URL env var)

  • --username TEXT: CalDAV username (or set CALDAV_TASKS_API_USERNAME env var)

  • --password TEXT: CalDAV password (or set CALDAV_TASKS_API_PASSWORD env var)

  • --nextcloud-mode / --no-nextcloud-mode: Adjust URL for Nextcloud (default: True)

  • --debug / --no-debug: Enable interactive debugging console (default: False). Also changes the log level, which by default is WARNING (or set CALDAV_TASKS_API_LOG_LEVEL)

Specific command options:

  • show_summary:

    • --list TEXT, -l TEXT: Specify a task list name or UID to load (can use multiple times)

    • --json / --no-json: Output summary information in JSON format (default: False)

    • --read-only / --read-write: Operate in read-only mode (default) or allow modifications (e.g., for debug console usage).

  • add-task:

    • --list-uid TEXT: UID of the task list (or CALDAV_TASKS_API_DEFAULT_LIST_UID env var). Mandatory if env var not set.

    • --summary TEXT: Summary/text of the task (required).

    • --description TEXT: Description for the task.

    • --priority INTEGER: Priority of the task (0-9, where 0 means undefined) [default: 0].

    • --due-date TEXT: Due date in format YYYYMMDD or YYYYMMDDTHHMMSSZ (e.g., 20240315 or 20240315T143000Z).

    • --start-date TEXT: Start date in format YYYYMMDD or YYYYMMDDTHHMMSSZ (e.g., 20240315 or 20240315T143000Z).

    • --tag TEXT: Add a tag/category to the task (can be used multiple times).

    • --parent TEXT: UID of the parent task (for creating subtasks).

    • --x-property TEXT: Add a custom X-property in format KEY=VALUE (can be used multiple times). Example: –x-property X-CUSTOM-FIELD=myvalue

    • --percent-complete INTEGER: Completion percentage (0-100) [default: 0].

  • list-latest-tasks:

    • --list-uid TEXT: UID of the task list to filter from (or CALDAV_TASKS_API_DEFAULT_LIST_UID env var).

    • --limit INTEGER: Maximum number of tasks to return (default: 10). Output is always JSON.

  • list-lists: Output is always JSON.

Note on Read/Write Modes:

  • The show_summary command has a --read-only / --read-write flag, defaulting to read-only mode (--read-only). Use --read-write if you intend to use the debug console (--debug) for write operations with the api object.

  • The add-task command always operates in write mode (it initializes its API connection with read_only=False). It does not have a --read-only or --read-write flag.

  • The list-latest-tasks and list-lists commands always operate in read-only mode (they initialize their API connections with read_only=True). They do not have --read-only or --read-write flags.

Python API

The Python API offers more fine-grained control. An example of its usage can be found in the documentation in the examples.

Note: For a detailed reference of the Python API classes and methods, please see the API documentation.