# todoist-python - The official Todoist Python API library
## How to get started
Requirements:
Python 2.7+
Virtualenv: https://pypi.python.org/pypi/virtualenv
Clone the repo:
$ git clone git@github.com:Doist/todoist-python.git
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 $ python >>> import todoist >>> api = todoist.TodoistAPI() >>> user = api.login('john.doe@gmail.com', 'secret') >>> print(user['full_name']) John Doe >>> response = api.sync(resource_types=['all']) >>> 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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file todoist-python-0.2.25.tar.gz.
File metadata
- Download URL: todoist-python-0.2.25.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6441abe7d6935c295fce74dbf0fb458e0bf7b71dfc90bf63ba38580df4b1d486
|
|
| MD5 |
a31c2b34b5f2ff838589d3cb9588cef0
|
|
| BLAKE2b-256 |
59d4a8b79e1cbf1ff4b5eb870522959d48e563b688083c002ffe7ff717c46cb9
|
