earnestma
/
autodoist
forked from mirrors/autodoist
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README.md

master
Hoffelhas 2020-03-30 11:37:10 +02:00
parent 3ef9371967
commit a616e2eba9
1 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,31 +1,37 @@
NextAction
==========
A more GTD-like workflow for Todoist. Uses the REST API to add and remove a `@next_action` label from tasks.
A more GTD-like workflow for Todoist.
This program looks at every list in your Todoist account.
Any list that ends with `_` or `.` is treated specially, and processed by NextAction.
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.
Note that NextAction requires Todoist Premium to function properly, as labels are a premium feature.
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.
Requirements
============
* Python 2.7, Python 3.0+ is unsupported at the moment
* Python 3.8
* ```todoist-python``` package.
Activating NextAction
=====================
Projects and parentless tasks can be tagged independently from each other to create the required functionality.
Sequential list processing
--------------------------
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
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
------------------------
If a project or task name ends with `.`, the child tasks will be treated as parallel `@next_action`s.
The waterfall processing will be applied the same way as sequential lists - every parent task will be treated as sequential. This can be overridden by appending `_` to the name of the parent task.
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
------------------------
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.
Executing NextAction
====================
@ -38,3 +44,16 @@ 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
python nextaction.py -a <API Key>
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:
python nextaction.py --parallel_suffix <tah>
python nextaction.py --serial_suffix <tag>