Skip to main content

todoist-python - The official Todoist Python API library

Project description

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

Project details


Download files

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

Source Distribution

todoist-python-7.0.12.tar.gz (18.6 kB view details)

Uploaded Source

File details

Details for the file todoist-python-7.0.12.tar.gz.

File metadata

File hashes

Hashes for todoist-python-7.0.12.tar.gz
Algorithm Hash digest
SHA256 03ef6a28b085227b996095eb849a5946f418d2870f5c38c952a22a4c97a499a0
MD5 2ce0f495cb880c04750961c38f0f35cf
BLAKE2b-256 7eb83ab736cf32e74b086e5279b33c28ded805b18d1cb7b992a4fbf46852aafb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page