autodoist/README.md

60 lines
1.9 KiB
Markdown
Raw Normal View History

2014-03-09 23:55:47 -04:00
NextAction
==========
2020-03-30 05:37:10 -04:00
A more GTD-like workflow for Todoist.
2020-03-30 05:37:10 -04:00
This program looks for pre-defined tags in every list and parentless task in your Todoist account to automatically add and remove `@next_action` labels.
2020-03-30 05:37:10 -04:00
The result will be a clear, current and comprehensive list of next actions without the need for further thought.
Uses the Todoist Sync API; note that Todoist Premium is required to function properly, since labels are used.
2014-11-15 14:58:01 -05:00
Requirements
============
2020-03-30 05:37:10 -04:00
* Python 3.8
* ```todoist-python``` package.
2014-11-15 14:58:01 -05:00
Activating NextAction
2014-11-15 14:58:01 -05:00
=====================
2020-03-30 05:37:10 -04:00
Projects and parentless tasks can be tagged independently from each other to create the required functionality.
Sequential list processing
2014-11-15 14:58:01 -05:00
--------------------------
2020-03-30 05:37:10 -04:00
If a project or task ends with `--`, the child tasks will be treated as a priority queue and the most important will be labeled `@next_action`. Importance is determined by order in the list.
Parallel list processing
2014-11-15 14:58:01 -05:00
------------------------
2020-03-30 05:37:10 -04:00
If a project or task name ends with `//`, the child tasks will be treated as parallel `@next_action`s.
A waterfall processing is applied, where the lowest possible children tasks are labelled.
Parentless tasks
------------------------
2020-03-30 05:37:57 -04:00
Any parentless task can be be given a type by appending `//` or `--` to the name of the task. This works if there is no list type, and will override a previously defined list type.
2014-11-15 14:38:44 -05:00
Executing NextAction
====================
2015-12-12 09:20:48 -05:00
You can run NexAction from any system that supports Python.
2014-11-15 14:38:44 -05:00
Running NextAction
------------------
NextAction will read your environment to retrieve your Todoist API key, so to run on a Linux/Mac OSX you can use the following commandline
2015-09-05 10:56:30 -04:00
python nextaction.py -a <API Key>
2020-03-30 05:37:10 -04:00
Additional arguments
------------------
Several arguments can be provided, for example to change the default label:
python nextaction.py -l <label>
Or to change the suffix tags:
2020-03-30 05:37:57 -04:00
python nextaction.py --parallel_suffix <tag>
2020-03-30 05:37:10 -04:00
python nextaction.py --serial_suffix <tag>