|Óscar García Amor a0c5b74bfc Fix a variable name||3 months ago|
|.github||1 year ago|
|contrib||1 year ago|
|trellowarrior||3 months ago|
|.gitignore||4 years ago|
|CONTRIBUTING.md||2 years ago|
|LICENSE||2 years ago|
|MANIFEST.in||2 years ago|
|README.md||6 months ago|
|requirements.txt||4 years ago|
|setup.py||2 years ago|
|trellowarrior.conf||2 years ago|
|trellowarrior.py||2 years ago|
Tool to sync Taskwarrior projects with Trello boards.
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
# 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.
yay -S trellowarrior
Or if you prefer a fully binary package you can configure Connectical Arch Linux repository.
Simply create a Python 3 virtualenv and install via pip:
python3 -m venv trw . trw/bin/activate python3 -m pip install trellowarrior
You can use your package system to install it, but the best way is to use a Python 3 virtualenv:
python3 -m venv trw . trw/bin/activate python3 -m pip install tasklib python3 -m pip install py-trello
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
--name are optional, they are set by default to
You can set the
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.
The TrelloWarrior config is very easy. There is a
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
$XDG_CONFIG_HOME/trellowarrior/trellowarrior.conf (fallbacks to
~/.config/trellowarrior/trellowarrior.conf), or set the configuration file
To synchronize Trello and Taskwarrior, simply call TrelloWarrior with the sync command or without any command.
You can also add a list of project(s) to synchronize:
trellowarrior sync project1 project2
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_locationOptional. Define where your taskrc file is located. Default:
taskwarrior_data_location Optional. Define where your task data dir is located. Default:
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.
The Project/Board sections are called from
sync_projects and define the
equivalence between Taskwarrior and Trello.
taskwarrior_project_nameMANDATORY. The name of project in Taskwarrior.
trello_board_nameMANDATORY. The name of Trello Board.
trello_todo_listOptional. The name of Trello list where new pending tasks are stored. Default:
trello_doing_listOptional. The name of Trello list for active tasks. Default:
trello_done_listOptional. The name of Trello list for done taks. Default:
trello_lists_filterOptional. To filter Trello lists from syncing.
only_my_cardsOptional. Sync ony cards / tasks assigned to me.
|UDA: trelloid||Card ID|
|UDA: trellolistname||List Name|
|Due||Card Due Date|
|Annotation: [Trello URL]||Card URL|
|Annotation: [Trello Description]||Card Description|
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.
If you modify Card URL or Card Description in Trello, the old annotation will be deleted and replaced by a new one.
If you want to delete a due date you must do it in both Taskwarrior and Trello.
For now, only syncs Title/Description, Due dates, Labels, Card URL, Card Description and Status.
This software is licensed under the terms of the GNU General Public License version 3 (GPLv3).