mirrors
/
autodoist
mirror of https://github.com/Hoffelhas/autodoist
1
0
Fork 1
Code Issues Releases Activity

Update README.md

pull/15/head v1.2
Hoffelhas 2020-05-30 14:46:19 +02:00 committed by GitHub
parent ff31adc65b
commit 3d8fb97c93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -3,7 +3,8 @@
This program adds two major functionalities to Todoist to help automate your workflow: This program adds two major functionalities to Todoist to help automate your workflow:
1) Assign automatic `@next_action` labels for a more GTD-like workflow 1) Assign automatic `@next_action` labels for a more GTD-like workflow
2) Enable re-use of subtasks in lists with a recurring date 2) Enable regeneration of sub-tasks in lists with a recurring date
3) Postpone the end-of-day time to after midnight to finish your daily recurring tasks
If this tool helped you out, I would really appreciate your support by providing me with some coffee! If this tool helped you out, I would really appreciate your support by providing me with some coffee!
@ -22,7 +23,7 @@ The program looks for pre-defined tags in the name of every project and parentle
Projects and parentless tasks can be tagged independently from each other to create the required functionality. If this tag is not defined, it will not activate this functionality. The result will be a clear, current and comprehensive list of next actions without the need for further thought. Projects and parentless tasks can be tagged independently from each other to create the required functionality. If this tag is not defined, it will not activate this functionality. The result will be a clear, current and comprehensive list of next actions without the need for further thought.
Make sure the label ```next_action``` exists in your Todoist before running the program. The default label can be changed, see the example given at [additional arguments](#additional-arguments). Todoist Premium is required in order to use labels and to make this functionality possible. See the example given at [running autodoist](#running-autodoist) on how to run this mode. Make sure that the label exists in your Todoist before running. Todoist Premium is required in order to use labels and to make this functionality possible.
## Sequential list processing ## Sequential list processing
@ -47,10 +48,17 @@ Any parentless task can be be given a type by appending `//` or `--` to the name
# Recurring lists # Recurring lists
The program looks for all parentless tasks with a recurring date. If they contain sub-tasks, they will be restored in the same order when the parentless task is checked. Todoist Premium is not required for this functionality. The program looks for all parentless tasks with a recurring date. If they contain sub-tasks, they will be regenerated in the same order when the parentless task is checked. Todoist Premium is not required for this functionality.
![See example](https://i.imgur.com/WKKd14o.gif) ![See example](https://i.imgur.com/WKKd14o.gif)
# Postpone the end-of-day
You have a daily recurring task, but you're up working late and now it's past midnight. Todoist will automatically mark it overdue and when you check it, it moved to tomorrow. After a good nights rest you can't complete the task that day!
By setting an alternative time for the end-of-day you can now finish your work after midnight and the new date will automatically be corrected for you. Todoist Premium is not required for this functionality.
![See example 1](https://i.imgur.com/tvnTMOJ.gif)
# Executing Autodoist # Executing Autodoist
@ -58,29 +66,33 @@ You can run Autodoist from any system that supports Python.
## Running Autodoist ## Running Autodoist
Autodoist will read your environment to retrieve your Todoist API key, so to run on Windows/Linux/Mac OSX you can use the following commandline: Autodoist will read your environment to retrieve your Todoist API key and additional arguments. In order to run on Windows/Linux/Mac OSX you can use the following commandlines.
python autodoist.py -a <API Key> If you want to enable labelling mode, run with the `-l` argument:
If you want to enable recurring re-use mode, run with the `-r` argument: python autodoist.py -a <API Key> -l <LABEL_NAME>
If you want to enable regeneration of sub-tasks in recurring lists, run with the `-r` argument:
python autodoist.py -a <API Key> -r python autodoist.py -a <API Key> -r
If you want to enable an alternative end-of-day, run with the `-e` argument and a number from 1 to 24 to specify which hour:
python autodoist.py -a <API Key> -e <NUMBER>
These modes can be run individually, or combined with each other.
## Additional arguments ## Additional arguments
Several arguments can be provided, for example to change the default label: Several additional arguments can be provided, for example to change the suffix tags for parallel and sequential projects:
python autodoist.py -l <label> python autodoist.py --p_suffix <tag>
python autodoist.py --s_suffix <tag>
Or to change the suffix tags:
python autodoist.py --parallel_suffix <tag>
python autodoist.py --serial_suffix <tag>
In addition, if you experience issues with syncing you can increase the api syncing time (default 5 seconds): In addition, if you experience issues with syncing you can increase the api syncing time (default 5 seconds):
python autodoist.py --delay <time in seconds> python autodoist.py --delay <time in seconds>
For all arguments check help: For all arguments check the help:
python autodoist.py --help python autodoist.py --help