The official Todoist Python API library
Clone or download
Pull request Compare This branch is 4 commits behind Doist:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
tests
todoist
.gitignore
LICENSE
MANIFEST.in
README.md
pytest.ini.sample
setup.cfg
setup.py
tox.ini

README.md

todoist-python - The official Todoist Python API library

How to get started

Requirements:

Clone the repo and enter it:

$ git clone git@github.com:Doist/todoist-python.git ; cd todoist-python

Create an environment:

$ virtualenv --system-site-packages -p /usr/bin/python2.7 Env

Activate the environment:

$ source Env/bin/activate

Install the library along with all the dependencies (so far we depend on awesome requests only):

$ pip install -e .

If you want to build the documentation as well, install some extra packages:

$ pip install -r doc/requirements.txt

Build the documentation:

$ (cd doc ; make html)

Read the built documentation by opening:

doc/_build/html/index.html

Import the library and try some commands:

$ python
>>> import todoist
>>> api = todoist.TodoistAPI()
>>> user = api.user.login('john.doe@gmail.com', 'secret')
>>> print(user['full_name'])
John Doe
>>> response = api.sync()
>>> for project in response['projects']:
...     print(project['name'])
...
Personal
Shopping
Work
Errands
Movies to watch

Testing the library

We have a set of tests to ensure we support Python both 2.x and 3.x. To test it out, please make sure you have python 2.7 and python 3.4 installed in you system. Then install "tox" either globally (preferred way) or in your local environment.

# apt-get install python-tox

or

$ pip install tox

Then just type

$ tox