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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

todoist_python-7.0.18-py2.py3-none-any.whl (22.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file todoist_python-7.0.18-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for todoist_python-7.0.18-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b362ec7296886f6fdb1e4fb367ee33dfb5903f1fbe0f7626543f58294b6df7d0
MD5 ec2ed10ba509bc5488821d6931edf04d
BLAKE2b-256 579dc6b33affe95c66590808a40d61d99a5ff94473dc6ed84127b83119fa4ec3

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