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.
Install
pip install py-trello
Usage
from trello import TrelloClient
client = TrelloClient(
api_key='your-key',
api_secret='your-secret',
token='your-oauth-token-key',
token_secret='your-oauth-token-secret'
)Where token and token_secret come from the 3-legged OAuth process and api_key and api_secret are your Trello API credentials that are (generated here).
To use without 3-legged OAuth, use only api_key and api_secret on client.
Working with boards
all_boards = client.list_boards()
last_board = all_boards[-1]
print(last_board.name)working with board lists and cards
all_boards = client.list_boards()
last_board = all_boards[-1]
last_board.list_lists()
my_list = last_board.get_list(list_id)
for card in my_list.list_cards():
print(card.name)Getting your Trello OAuth Token
Make sure the following environment variables are set:
TRELLO_API_KEY
TRELLO_API_SECRET
These are obtained from the link mentioned above.
TRELLO_EXPIRATION is optional. Set it to a string such as ‘never’ or ‘1day’. Trello’s default OAuth Token expiration is 30 days.
Default permissions are read/write.
More info on setting the expiration here: https://trello.com/docs/gettingstarted/#getting-a-token-from-a-user
Run
python -m trello oauth
Required Python modules
Found in requirements.txt
Tests
To run the tests, run python -m unittest discover. Four 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
TRELLO_TEST_STAR_COUNT: the number of stars on your test Trello board
WARNING: The tests will delete all cards on the board called TRELLO_TEST_BOARD_NAME!
To run tests across various Python versions, tox is supported. Install it and simply run tox from the py-trello directory.
1 maintainer
Release files for py-trello 0.20.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 | |
|---|---|---|---|
| py_trello-0.20.1.tar.gz | 31.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py_trello-0.20.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 73.0 kB
Release files / py_trello-0.20.1.tar.gz
| Download URL | py_trello-0.20.1.tar.gz |
|---|---|
| Size | 31.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a5b5a915fff2752258fb8a8dfe1c7ed32e78aabbeaea1bfcc1ea926b9c54338f
|
|
BLAKE2b-256 checksum How to use checksums |
1b242d127c428b87cf5e47c9c6d07b102db8ffb5ac71e8add154d2a85cfbaf1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.3
|
Release files / py_trello-0.20.1-py3-none-any.whl
| Download URL | py_trello-0.20.1-py3-none-any.whl |
|---|---|
| Size | 41.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8388552f166e3f3a820345ba2cc9e070603f0495396f05517b9ed6d533ea48e0
|
|
BLAKE2b-256 checksum How to use checksums |
ac3b48b2e1ad0d11ed03e4fd1409d17894ccf2b00e68909bc6ced5778df2c067
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.3
|
