Skip to content

Commit 5710c5a

Browse files
committed
Convert README to markdown, clarify installation/usage instructions
1 parent 40a8f0f commit 5710c5a

File tree

2 files changed

+49
-46
lines changed

2 files changed

+49
-46
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Habitica-todo
2+
3+
This is intended to be a two-way sync of Habitica and todoist. Any tasks that can't be found in both services should appear on the others, with the same status. If you complete a task on one service, it should appear as completed on another. Tasks that are created on Habitica should be sent to the 'Inbox' project on Todoist.
4+
5+
AS A NOTE: in order to have two way syncing, you MUST have a paid copy of Todoist. It's not possible for me to port complete tasks from Todoist otherwise. If you do not have a paid copy of Todoist, the following will happen:
6+
7+
1. Completed tasks will not sync between the services.
8+
2. Tasks that you begin and complete from one service to the other will not transfer between the two.
9+
10+
That means that if you create a task in Todoist and then check it off, right now it will _not_ send the points to Habitica.
11+
12+
I encourage people without paid todoist to pick up todoist-habitrpg, which doesn't care one way or the other. (I rather hope that kusold's success with that means that Habitica-todoist will be able to figure this out eventually, but right now that's my workaround.) Or you could pony up the $30 for a year's subscription of Todoist. I'm pretty sure it's worth it.
13+
14+
## INSTALLATION
15+
16+
There are two dependencies you'll need to install, and the commands to install them are as follows:
17+
```
18+
pip install todoist-python
19+
pip install requests
20+
```
21+
Finally, you need to add your API tokens to the `Habitica-todo/auth.cfg.example` file. You can find your Habitica API User ID and API key by visiting https://habitica.com/user/settings/api while logged in, and your Todoist API token can be found by visiting https://todoist.com/prefs/integrations while logged in. Once you've added these tokens, you should rename the file to `Habitica-todo/auth.cfg` (remove the '.example' at the end).
22+
23+
## TASK DIFFICULTY
24+
25+
I originally felt that it would be good if task difficulty translated between tasks created on Todoist and Habitica. Therefore, task difficulty should sync with the following code by default, as laid out in `main.py`
26+
27+
Todoist priority | Habitica difficulty
28+
---------------- | -------------------
29+
p1 | Hard
30+
p2 | Medium
31+
p3 | Easy
32+
p4 | Easy
33+
34+
If you'd like to change how the sync interprets difficulty or priority, please edit `main.py`. For example, my personal setup actually includes translating Todoist p4 to Easy, rather than Trivial, because I find that Trivial yields so few rewards they aren't worth it to me.
35+
36+
## USAGE
37+
38+
Try running `python Habitica-todo/oneWaySync.py` in your terminal.
39+
40+
## INSPIRATION
41+
42+
I'd like to credit several existing apps that I pulled from in order to create this. Notably:
43+
44+
* Philadams' existing habitica app, for a lot of initial code and many helpful explanations of how to do things
45+
* The existing API!
46+
* Pytodoist
47+
* Dee Dee whose scriptabit which provided a lot of ideas
48+
49+
THANKS

README.txt

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)