Skip to main content

Taskwarrior <-> Google Calendar synchronisation tool

Project description

Taskwarrior - Google Calendar synchroniser

master devel
 _            _                                _
| |_ __ _ ___| | ____      __   __ _  ___ __ _| |    ___ _   _ _ __   ___
| __/ _` / __| |/ /\ \ /\ / /  / _` |/ __/ _` | |   / __| | | | '_ \ / __|
| || (_| \__ \   <  \ 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
  • ONGOING Deletion of an event

The aforementioned features should work bidirectional, meaning a reminder created in Taskwarrior is uploaded to Google calendar. If either side modifies it, then the other side is also getting the modification and vice-versa

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

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 a cron.

Installation instructions

Requirements:

  • Taskwarrior - Installation instructions
  • Python version >= 3.5 (yes I know, but mypy rocks!)
  • Python package dependencies: pip3 install --user . # from the repo root dir

Usage instructions

TODO

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.

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.

Source Distribution

taskw_gcal_sync-0.0.2.tar.gz (15.7 kB view hashes)

Uploaded Source

Built Distribution

taskw_gcal_sync-0.0.2-py3-none-any.whl (18.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page