# 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:
Python 2.7+
Virtualenv: https://pypi.python.org/pypi/virtualenv
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
Release files for todoist-python 8.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| todoist-python-8.1.1.tar.gz | 18.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| todoist_python-8.1.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 42.7 kB
Release files / todoist-python-8.1.1.tar.gz
| Download URL | todoist-python-8.1.1.tar.gz |
|---|---|
| Size | 18.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da22f97c353fb0af435dd06194b1c72d0f8ac1c6ea987af0d51b3fb091bb114e
|
|
BLAKE2b-256 checksum How to use checksums |
90db8f7c4836b37205c951f82a17827ebd52e9e0cc73ecbb9df0312f5558c513
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16
|
Release files / todoist_python-8.1.1-py2.py3-none-any.whl
| Download URL | todoist_python-8.1.1-py2.py3-none-any.whl |
|---|---|
| Size | 23.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
f38c04ae3704c8318f5397e2e1c34586260e06b3f2e0f659eec91a56a08d1fc6
|
|
BLAKE2b-256 checksum How to use checksums |
65219c1260c10df84be644fb49bd2813a4a2ed293b4f6e42b08089a0cf0390a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.16
|
