summaryrefslogtreecommitdiff
path: root/README.md
blob: 3991aadf4892d0fa7f52006d89e70c4ae8173518 (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

Inbox for Todoist

An Übersicht widget for your Todoist Inbox

$

About

Inbox for Todoist 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 or Felix Hageloh

Below is a preview of what Inbox for Todoist can look like:

In some context with other widgets, your interface could look like this:

Requirements
• Python 3
• Todoist's Python Package

Installing Python 3

From python's web site

Download and install the latest version of python 3 from this website :

https://www.python.org/downloads/mac-osx/

Using homebrew (Recommended)
• 
First install homebrew (if not already installed):

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install )"

• 
Run the following command in a terminal window:

brew install python

Installing Todoist's Python Package

Open a terminal window and type:

pip3 install todoist-python



Installation

Clone this repository to your Übersicht folder: ~/Library/Application Support/Übersicht/widgets/ 

Setting up your own Todoist Token

The inbox_for_todoist folder contains a file named todoist_API.txt . In that file, replace ___YOUR TODOIST TOKEN HERE:___ with your own token.

You todoist token can be found on Todoist inside of settings and then Integrations . It will be labelled as API Token .

Rest assured that if you submit a pull request, your token will not be shared as todoist_API.txt has been set to be ignored by github inside the .gitignore file line: 108 . Also none of your tasks stored inside your offline cache will be shared as todoist.cache has been set to be ignored by github inside the .gitignore file line: 105 .

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:


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) .

Recent Updates
•  2018-11-04 Widget now keeps an offline cache of your tasks
• No more Error messages when you computer's offline (due to cache)

•  2018-11-04 API keys are stored on a .txt file outside the script. ( todoist_API.txt )
•  2018-10-03 Priority color coding Support

Possible Eventual Improvements

(checked items are under developpement)
• [ ] Task Sorting
• [ ] Tasks sorted by due date first
• [ ] Task sorted by priority second

• [ ] Todoist Markdown Support
• [ ] Indent embedded subtasks