Update README.md

master
Hoffelhas 2020-12-30 14:12:56 +01:00 committed by GitHub
parent ea20ad2aa1
commit d1f6ac802c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 9 deletions

View File

@ -1,12 +1,13 @@
# Autodoist # Autodoist
This program adds three major functionalities to Todoist to help automate your workflow: This program adds four 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
- Flexible options to label tasks sequentially or in parallel - Flexible options to label tasks sequentially or in parallel
- Limit labels based on a start-date or hide future tasks based on the due date - Limit labels based on a start-date or hide future tasks based on the due date
2) Enable regeneration of sub-tasks 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 3) Postpone the end-of-day time to after midnight to finish your daily recurring tasks
4) Make multiple items uncheckable / re-checkable at the same time
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!
@ -21,31 +22,31 @@ If this tool helped you out, I would really appreciate your support by providing
# 1. Automatic next action labels # 1. Automatic next action labels
The program looks for pre-defined tags in the name of every project and parentless tasks in your Todoist account to automatically add and remove `@next_action` labels. To create a simple list of all your next actions you can add a new filter in your Todoist with e.g.: @next_action & #project_name. The program looks for pre-defined tags in the name of every project, section, or parentless tasks in your Todoist account to automatically add and remove `@next_action` labels. To create a simple list of all your next actions you can add a new filter in your Todoist with e.g.: @next_action & #project_name.
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, sections, 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.
See the example given at [running autodoist](#running-autodoist) on how to run this mode. If the label does not exist yet in your Todoist, a possibility is given to automatically create it. 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. If the label does not exist yet in your Todoist, a possibility is given to automatically create it. Todoist Premium is required in order to use labels and to make this functionality possible.
## Sequential processing ## Sequential processing
If a project or parentless task ends with `--`, both the parentless tasks and its sub-tasks will be treated as a priority queue and the most important will be labeled. Importance is determined by order in the list. If a project, section, or parentless task ends with `--`, both the parentless tasks and its sub-tasks will be treated as a priority queue and the most important will be labeled. Importance is determined by order in the list.
![Serial task](https://i.imgur.com/SUkhPiE.gif) ![Serial task](https://i.imgur.com/SUkhPiE.gif)
## Parallel processing ## Parallel processing
If a project or parentless task name ends with `//`, both the parentless tasks and its sub-tasks will be treated as parallel. A waterfall processing is applied, where the lowest possible sub-tasks are labelled. If a project, section, or parentless task name ends with `//`, both the parentless tasks and its sub-tasks will be treated as parallel. A waterfall processing is applied, where the lowest possible sub-tasks are labelled.
![Parallel task](https://i.imgur.com/NPTLQ8B.gif) ![Parallel task](https://i.imgur.com/NPTLQ8B.gif)
## Added labelling flexibility ## Added labelling flexibility
If a project ends with `-/`, all parentless tasks are processed sequentially, and its sub-tasks in parallel. If a project or section ends with `-/`, all parentless tasks are processed sequentially, and its sub-tasks in parallel.
[See example](https://i.imgur.com/uGJFeXB.gif) [See example](https://i.imgur.com/uGJFeXB.gif)
If a project ends with `/-`, all parentless tasks are processed in parallel, and its sub-tasks sequentially. If a project or section ends with `/-`, all parentless tasks are processed in parallel, and its sub-tasks sequentially.
[See example](https://i.imgur.com/5lZ1BVI.gif) [See example](https://i.imgur.com/5lZ1BVI.gif)
@ -55,12 +56,14 @@ Any parentless task can also be be given a type by appending `//` or `--` to the
[See example 2 with a serial project](https://i.imgur.com/JfaAOzZ.gif) [See example 2 with a serial project](https://i.imgur.com/JfaAOzZ.gif)
Note: Todoist sections don't like to have a slash in the name, it will automatically change to an underscore. The default label options will recognise this to make it work regardless. Of course you're always free to define your own custom label symbols.
## Start/Due date enhanced experience ## Start/Due date enhanced experience
Two methods are provided to hide tasks that are not relevant yet. Two methods are provided to hide tasks that are not relevant yet.
- Prevent labels by defining a start-date. The label is only assigned if this date is reached. A start date can be added to a task by adding 'start=DD-MM-YYYY'. - Prevent labels by defining a start-date that is added to the task itself. The label is only assigned if this date is reached. You can define the start-date by adding 'start=DD-MM-YYYY'. On the other hand the start date can be defined as several days or weeks before the due-date by using either 'start=due-<NUMBER_OF_DAYS>d' or 'start=due-<NUMBER_OF_WEEKS>w'. This is especially useful for recurring tasks!
[See an example of using start-dates](https://i.imgur.com/WJRoJzW.png). [See an example of using start-dates](https://i.imgur.com/WJRoJzW.png).
- Prevent labels of all tasks if the due date is too far in the future. Define the amount by running with the argument '-hf <NUMBER_OF_DAYS>'. - Prevent labels of all tasks if the due date is too far in the future. Define the amount by running with the argument '-hf <NUMBER_OF_DAYS>'.
[See an example of the hide-future functionality](https://i.imgur.com/LzSoRUm.png). [See an example of the hide-future functionality](https://i.imgur.com/LzSoRUm.png).
@ -79,6 +82,12 @@ By setting an alternative time for the end-of-day you can now finish your work a
![See example 1](https://i.imgur.com/tvnTMOJ.gif) ![See example 1](https://i.imgur.com/tvnTMOJ.gif)
# 4. Make multiple items uncheckable / re-checkable at the same time
Todoist allows the asterix symbol `* ` to be used to ensure tasks can't be checked by turning them into headers. Now you are able to do this en masse!
Simply add `** ` or `!* ` in front of a project, section, or top item, to automatically turn all the items that it includes into respectively headers or checkable tasks.
# Executing Autodoist # Executing Autodoist
You can run Autodoist from any system that supports Python. You can run Autodoist from any system that supports Python.