summaryrefslogtreecommitdiff
path: root/README.md
blob: f14931234a4ce5382557d03e278ac1e210b1010e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# Inbox for [Todoist](https://en.todoist.com/tour) #
## An Übersicht widget for your Todoist Inbox ##
---
## About ##
Inbox for [Todoist](https://en.todoist.com/tour) is a simple Übersicht widget designed to present your todoist inbox on your Desktop. It is in no way affiliated with the Brand Todoist or Doist in any way nor is it affiliated with [Übersicht](http://tracesof.net/uebersicht/) or [Felix Hageloh](https://github.com/felixhageloh)


Below is a preview of what Inbox for Todoist can look like:
![Screenshot](screenshot.png)


In some context with other widgets, your interface could look like this:
![Screenshot 2](screenshot2.png)
## Installation ##
Clone this repository to your Übersicht folder:
`~/Library/Application Support/Übersicht/widgets/`

### Setting up your own Todoist Token ###
On the second line of the `todoistinbox.py` file, replace
`___YOUR TODOIST TOKEN HERE:___` (keep the ' ' for it to work) with your very own todoist API token.


You todoist token can be found on [Todoist](https://todoist.com) inside of `settings` and then `Integrations`. It will be labelled as `API Token`.

## Preferences ##
### Refresh Rate ###
By default, Inbox for Todoist refreshes every second. To reduce CPU & Memory Usage, you may go to line 5 of `index.coffee` and adjust this:
-   Removing the first `#` will make the widget refresh every `minute`.
-   Removing the second `#` will make the widget refresh every `5 minutes`.
-   Removing the third `#` will make the widget refresh every `10 minutes`.
-   Removing the fourth `#` will make the widget refresh every `20 minutes`.
-   Removing the fifth `#` will make the widget refresh every `hour`.
-   Removing the sixth `#` will make the widget refresh every `12 hours`.
## Priority Color Coding ##
You can change the colors of tasks inside of the `.coffee` file.
By default, tasks are colored the same way they are in the todoist mac app in dark.
The following line to edit are:
-   To edit the color of tasks labelled `priority1`, edit the `rgba(r, g, b, a)` on line `21`
-   To edit the color of tasks labelled `priority2`, edit the `rgba(r, g, b, a)` on line `23`
-   To edit the color of tasks labelled `priority3`, edit the `rgba(r, g, b, a)` on line `25`
-   To edit the color of tasks labelled `priority4`, edit the `rgba(r, g, b, a)` on line `27`

The default color for the widget is `rgba(#F2F2F2, 1.0)`.

## Possible Eventual Improvements ##
(checked items are under developpement)
-   [ ] Due Date Sorting
-   [ ] Todoist Markdown Support
-   [ ] Keep a record of tasks offline
    -   [ ] Display an `Offline` indicator
-   [ ] Indent embedded subtasks