README.md

WunderHabit

Level up in Habitica by completing todo's in Wunderlist.

Please note, this is neither an official Wunderlist nor an official Habitica project. Please use WunderHabit at your own risk!

Getting Started

WunderHabit is a simple Django application written in Python, which you can run on your own server.

If you are not familiar with Django, you might first head over to the Getting Started with Django docs.

Prerequisites

• You need a Wunderlist account
• Register your Wunderlist App to generate a Client ID and a Client Secret to interact with the Wunderlist API
• In order to communicate with the Wunderlist API, you need a webserver and a trusted SSL certificate for your domain. There are free certificates available, just google for it.

Install the Requirements

Create a virtualenv:

virtualenv venv_dir

Activate the virtualenv:

source venv_dir/bin/activate

Install the requirements:

pip install -r requirements.txt

Run the Django app

Create a local settings file local_settings.py based on the example local_settings.example.py and configure the parameters according to your setup (do not share this file!):

cp wunderhabit/local_settings.example.py wunderhabit/local_settings.py

Prepare the database:

python manage.py migrate

Run the test server to verify the installation:

python manage.py runserver 127.0.0.1:8001

Deploy the app

There are several good guides on how to deploy a Django application. Personally, I like the one from Michal Karzynski or Digital Ocean.

Acknowledgements

The following projects or libraries helped a lot to build WunderHabit:

• Django Project
• Requests: HTTP for Humans
• Bootstrap
• Django-Bootstrap3
• Gunicorn
• Habitica Python Wrapper