Tool to sync Taskwarrior projects with Trello boards

Óscar García Amor 6645e8d747 Bump version to 1.2.1 1 week ago
trellowarrior 6645e8d747 Bump version to 1.2.1 1 week ago
.gitignore c7022811de Package project, closes #6 2 years ago
CONTRIBUTING.md 9e62f757fa Fix url in contributors list 1 month ago
LICENSE 90e48829bc Complete refactoring 1 month ago
MANIFEST.in e93f8c6b58 Added user filter, closes #17 1 month ago
README.md 3b85c6a7df Force python3 in the virtualenv command of README.md 1 month ago
requirements.txt c7022811de Package project, closes #6 2 years ago
setup.py 90e48829bc Complete refactoring 1 month ago
trellowarrior.conf e93f8c6b58 Added user filter, closes #17 1 month ago
trellowarrior.py 90e48829bc Complete refactoring 1 month ago

README.md

TrelloWarrior

Tool to sync Taskwarrior projects with Trello boards.

Requirements

In Taskwarrior

First for all you need configure some UDAs in Taskwarrior to store some Trello data. This is very, very, very important. If you dont have the UDAs configured before run TrelloWarrior you'll destroy your Taskwarrior tasks data.

To set UDAs in Taskwarrior simply edit .taskrc and add the following lines.

# UDAs
uda.trelloid.type=string
uda.trelloid.label=Trello ID
uda.trellolistname.type=string
uda.trellolistname.label=Trello List Name

The first UDA trelloid is used to store the Trello Card ID and establish an equivalence between Trello Cards and Taskwarrior Tasks. Note that you never, never, never, never, (period), should edit this field.

The second UDA trellolistname is used to determine the Trello List where the Card/Task is stored. You can edit this field without problems to move the task to another list.

For TrelloWarrior

Prepare the environment

In Arch Linux

TrelloWarrior is packaged in AUR, to obtain it simply use your AUR helper. For example with yay:

yay -S trellowarrior

Or if you prefer a fully binary package you can configure Connectical Arch Linux repository.

The easy way

Simply create a Python 3 virtualenv and install via pip:

virtualenv -p python3 trw
. trw/bin/activate
pip install trellowarrior
By hand

For run TrelloWarrior you need to install tasklib and py-trello. TrelloWarrior uses these Python helpers to comunicate with Taskwarrior and Trello.

You can use your package system to install it, but the best way is to use a Python 3 virtualenv:

virtualenv -p python3 trw
. trw/bin/activate
pip install tasklib
pip install py-trello

Get the keys

TrelloWarrior access to Trello via API. You need generate an access token for it.

First go to: https://trello.com/app-key to get your API Key and API Secret.

Then call TrelloWarrior with the authenticate command:

trellowarrior auth --api-key your_api_key --api-key-secret your_api_secret --expiration 30days --name TrelloWarrior

Note: --expiration and --name are optional, they are set by default to 30days and TrelloWarrior respectively.

You can set the TRELLO_EXPIRATION to 1hour, 1day, 30days, never. We recomend use 30days for tests and never for daily use.

This return some like this.

Request Token:
    - oauth_token        = 1c5ad394834dde42a7655437ab3e0060
    - oauth_token_secret = dffc3a62622ef450028f685406bceacc

Go to the following link in your browser:
https://trello.com/1/OAuthAuthorizeToken?oauth_token=1c5ad334134dde46a8659437ab3e0069&scope=read,write&expiration=30days&name=trellowarrior
Have you authorized me? (y/n)

You must visit the link to authorize the token. This gives you a pin like this.

You have granted access to your Trello information.

To complete the process, please give this verification code:

  17894a35a2f745c3a184cf8e4bb5f1f9

Respond yes, and insert the pin.

What is the PIN? 17894a35a2f745c3a184cf8e4bb5f1f9
Access Token:
    - oauth_token = 0469c6271416af6eae10123fdae0afc1135e9082bb0b5ba87b2f8a1db9d7f0b1
    - oauth_token_secret = a978b159692cfc315377790669ac99a0

You may now access protected resources using the access tokens above.

The config file is now initialized with the needed configuration variables.

Configuration

The TrelloWarrior config is very easy. There is a trellowarrior.conf sample file that you can modify to set with your data.

You can place the config file with trellowarrior, in your home as ~/.trellowarrior.conf or (by default if not previous config file exists) following the XDG Specification in $XDG_CONFIG_HOME/trellowarrior/trellowarrior.conf (fallbacks to ~/.config/trellowarrior/trellowarrior.conf), or set the configuration file path with -c or --config argument.

To synchronize Trello and Taskwarrior, simply call TrelloWarrior with the sync command or without any command.

trellowarrior sync

You can also add a list of project(s) to synchronize:

trellowarrior sync project1 project2

DEFAULT Section

In the DEFAULT section, it is mandatory to set your Trello API key and token and, at least, one sync project. The sync project corresponds to the following sections that define the Taskwarrior project and Trello board equivalence.

  • taskwarrior_taskrc_location Optional. Define where your taskrc file is located. Default: ~/.taskrc
  • taskwarrior_data_location Optional. Define where your task data dir is located. Default: ~/.task

  • trello_api_key MANDATORY. Your Trello Api Key.

  • trello_api_secret MANDATORY. Your Trello Api Secret.

  • trello_token MANDATORY. Your Trello Token.

  • trello_token_secret MANDATORY. Your Trello Token Secret.

  • sync_projects MANDATORY. Define what sections are loaded, separated by spaces.

Project/Board Sections

The Project/Board sections are called from sync_projects and define the equivalence between Taskwarrior and Trello.

  • taskwarrior_project_name MANDATORY. The name of project in Taskwarrior.
  • trello_board_name MANDATORY. The name of Trello Board.
  • trello_todo_list Optional. The name of Trello list where new pending tasks are stored. Default: To Do
  • trello_doing_list Optional. The name of Trello list for active tasks. Default: Doing
  • trello_done_list Optional. The name of Trello list for done taks. Default: Done
  • trello_lists_filter Optional. To filter Trello lists from syncing.
  • only_my_cards Optional. Sync ony cards / tasks assigned to me.

Equivalences

Taskwarrior Trello
UDA: trelloid Card ID
UDA: trellolistname List Name
Project Board Name
Description Card Name
Due Card Due Date
Tags Card Labels

Known limitations

The main objective of TrelloWarrior is to be simple so it doesn't manage collisions. The sync strategy is last modified wins, this means that if you do a modification in Trello and later a modification in Taskwarrior, TrelloWarrior does the sync and keeps the Taskwarrior data, because it is the last touched.

You can have infinite lists in your Trello, but all of them are considered as pending. You only can have one doing list and one done list, but these lists can be configured.

If you have several boards with same name or several labels with same name, TrelloWarrior always picks the first one.

Only Trello labels with names are synchronized, you can apply labels without name but these are ignored.

If you remove a name from a label and left it without name, the action don't touch date of cards and in next sync a new label will be created with the removed name. You can rename labels without problems.

New labels are created by TrelloWarrior in black color.

For now, only syncs Title/Description, Due dates, Labels and Status.

Contributing

See CONTRIBUTING.

License

This software is licensed under the terms of the GNU General Public License version 3 (GPLv3).

Full text of the license is available in the LICENSE file and online.