Skip to main content

todoist-python - The official Todoist Python API library

Project description

# todoist-python - The official Todoist Python API library

## Quick Start

Install with

`bash pip install todoist-python `

Official Documentation can be found at https://todoist-python.readthedocs.io/en/latest/.

## Example Usage

Import the library and try some commands:

`python $ python >>> import todoist >>> api = todoist.TodoistAPI('0123456789abcdef0123456789abcdef01234567') >>> api.sync() >>> full_name = api.state['user']['full_name'] >>> print(full_name) John Doe >>> for project in api.state['projects']: ...     print(project['name']) ... Personal Shopping Work Errands Movies to watch `

## Building from Source

### Build Project

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 .

### Build Documentation

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

## 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

You will also need to have the pytest.ini file. We are providing a pytest.ini.sample that you can copy and paste to create your own pytest.ini. You will need two different tokens (token and token2 keys on on pytest.ini) to be able to run all the tests successfully.

With everything set up, you can just run:

$ tox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for todoist-python, version 8.1.1
Filename, size File type Python version Upload date Hashes
Filename, size todoist_python-8.1.1-py2.py3-none-any.whl (23.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size todoist-python-8.1.1.tar.gz (18.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page