Python wrapper around the Trello API
Project description
A wrapper around the Trello API written in Python. Each Trello object is represented by a
corresponding Python object. The attributes of these objects are cached, but the child objects are
not. This can possibly be improved when the API allows for notification subscriptions; this would
allow caching (assuming a connection was available to invalidate the cache as appropriate).
I've created a Trello Board for feature requests, discussion and some development tracking. It can
be found `here <https://trello.com/board/py-trello/4f145d87b2f9f15d6d027b53>`_.
Install
=======
pip install py-trello
py-oauth2
=========
py-oauth2 works if you apply the patch found `here <https://github.com/tylerwilliams/python-oauth2/commit/e97b6a678ea6df38f0f1c33a5a7450714a72c38b>`_. To use 3-legged authentication, construct your Trello client as follows:
client = Trello(api_key = '...', api_secret = '...', token = '...', token_secret = '...')
Where `token` and `token_secret` come from the 3-legged OAuth process. `api_key` and `api_secret`
are your Trello API credentials (`generated here <https://trello.com/1/appKey/generate>`_).
Required Python modules
=======================
* `httplib2 <http://code.google.com/p/httplib2/>`_
Tests
=====
To run the tests, run `python tests.py`. Three environment variables must be set:
* TRELLO_API_KEY: your Trello API key
* TRELLO_TOKEN: your Trello OAuth token
* TRELLO_TEST_BOARD_COUNT: the number of boards in your Trello account
* TRELLO_TEST_BOARD_NAME: name of the board to test card manipulation on. Must be unique, or the first match will be used
And run (from `py-trello/`):
PYTHONPATH=. python test/test_trello.py
Contributors
============
`Adrien Lemaire <https://github.com/Fandekasp>`_
corresponding Python object. The attributes of these objects are cached, but the child objects are
not. This can possibly be improved when the API allows for notification subscriptions; this would
allow caching (assuming a connection was available to invalidate the cache as appropriate).
I've created a Trello Board for feature requests, discussion and some development tracking. It can
be found `here <https://trello.com/board/py-trello/4f145d87b2f9f15d6d027b53>`_.
Install
=======
pip install py-trello
py-oauth2
=========
py-oauth2 works if you apply the patch found `here <https://github.com/tylerwilliams/python-oauth2/commit/e97b6a678ea6df38f0f1c33a5a7450714a72c38b>`_. To use 3-legged authentication, construct your Trello client as follows:
client = Trello(api_key = '...', api_secret = '...', token = '...', token_secret = '...')
Where `token` and `token_secret` come from the 3-legged OAuth process. `api_key` and `api_secret`
are your Trello API credentials (`generated here <https://trello.com/1/appKey/generate>`_).
Required Python modules
=======================
* `httplib2 <http://code.google.com/p/httplib2/>`_
Tests
=====
To run the tests, run `python tests.py`. Three environment variables must be set:
* TRELLO_API_KEY: your Trello API key
* TRELLO_TOKEN: your Trello OAuth token
* TRELLO_TEST_BOARD_COUNT: the number of boards in your Trello account
* TRELLO_TEST_BOARD_NAME: name of the board to test card manipulation on. Must be unique, or the first match will be used
And run (from `py-trello/`):
PYTHONPATH=. python test/test_trello.py
Contributors
============
`Adrien Lemaire <https://github.com/Fandekasp>`_
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
py-trello-0.1.1.tar.gz
(5.9 kB
view hashes)
Built Distribution
py_trello-0.1.1-py2.7.egg
(9.8 kB
view hashes)