Skip to main content

Taskwarrior <-> Google Calendar synchronisation tool

Project description

Taskwarrior - Google Calendar synchroniser

master devel
PyPI version
 _            _                                _
| |_ __ _ ___| | ____      __   __ _  ___ __ _| |    ___ _   _ _ __   ___
| __/ _` / __| |/ /\ \ /\ / /  / _` |/ __/ _` | |   / __| | | | '_ \ / __|
| || (_| \__ \   <  \ V  V /  | (_| | (_| (_| | |   \__ \ |_| | | | | (__
 \__\__,_|___/_|\_\  \_/\_/____\__, |\___\__,_|_|___|___/\__, |_| |_|\___|
                         |_____|___/           |_____|   |___/

Description

taskw_gcal_sync provides a solution for bidirectional synchronisation between Taskwarrior and Google Calendar. Given a Calendar name for Google Calendar and a filter for Taskwarrior (currently only a single tag is supported and tested) synchronise all the events between them.

Overall, it supports synchronisation on the following events:

  • Creation of an event
  • Modification of an (existing) event
  • Deletion of an event

The aforementioned features should work bidirectional, meaning a reminder created, modified, or deleted from Google Calendar should also be created, modified, or deleted respectively in TaskWarrior and vice-versa

Demo - initial run - filling of a Google Calendar

demo_gif

Motivation

While Taskwarrior is an excellent tool when it comes to keeping TODO lists, keeping track of project goals etc., lacks the portability, simplicity and minimalistic design of Google Calendar. The latter also has the following advantages:

  • Automatic sync across all your devices
  • Comfortable addition/modification of events using voice commands
  • Actual reminding of events with a variety of mechanisms

Installation instructions

Requirements:

  • Taskwarrior - Installation instructions
  • Python version >= 3.6 (yeah kind of restrictive, but mypy rocks!)
  • Python package dependencies: pip3 install --user --upgrade -r requirements.txt # from the repo root dir

Installation Choices:

  • Pypi: pip3 install --user --upgrade taskw_gcal_sync

    • (will not contain latest version)
  • github: pip3 install --user git+https://github.com/bergercookie/taskw_gcal_sync

  • Download and install locally - bleeding edge

    git clone https://github.com/bergercookie/taskw_gcal_sync
    cd taskw_gcal_sync
    git checkout devel
    pip3 install --user --upgrade -r requirements.txt
    

Usage instructions

Run the tw_gcal_sync to synchronise the Google calendar of your choice with the selected Taskwarrior tag(s). Run with --help for the list of options.

# Sync the +remindme Taskwarrior tag with the calendar named "TW Reminders"

tw_gcal_sync --help
tw_gcal_sync -t remindme -c "TW Reminders"

Mechanics

To achieve synchronization across the two services, we use a push-pull mechanism which is far easier and less troublesome than an automatic synchronization solution. In case the latter behavior is desired, users may just run the script periodically e.g., using cron:

$ crontab -e
...

# Add the following to sync every 10' - modify Calendar and Tag name accordingly
*/10 * * * * tw_gcal_sync -c "TW Reminders" -t "remindme" 2>&1 1>~/tw_reminders_latest.log

Troubleshooting

  • Having trouble installing or using the tool? Take a look at either the continuous-integration configuration or the unittsests for the installation steps or the recommended way of using the python code respectively.
  • Something doesn't work? Does the script fail midway through?
    • Record the problem and report it in the ISSUES page. Include as much information as possible so that I can reproduce it.

    • Clean the configuration file. By default that's going to be $HOME/.config/taskw_gcal_sync

      rm -rf ~/.config/taskw_gcal_sync

    • Remove the corresponding Google Calendar

    • Rerun synchronisation from scratch

Self Promotion

If you find this tool useful, please star it on Github

TODO List

See ISSUES list for the things that I'm currently either working on or interested in implementing in the near future. In case there's something you are interesting in working on, don't hesitate to either ask for clarifications or just do it and directly make a PR.

Project details


Download files

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

Files for taskw-gcal-sync, version 0.4.2
Filename, size File type Python version Upload date Hashes
Filename, size taskw_gcal_sync-0.4.2-py3-none-any.whl (23.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size taskw_gcal_sync-0.4.2.tar.gz (20.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page