https://github.com/insanum/py-trello

Python API wrapper around Trello's API
https://github.com/insanum/py-trello

Last synced: 5 months ago
JSON representation

Python API wrapper around Trello's API

• Host: GitHub
• URL: https://github.com/insanum/py-trello
• Owner: insanum
• License: bsd-3-clause
• Fork: true (sarumont/py-trello)
• Created: 2014-11-12T02:42:00.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-04T14:18:14.000Z (over 10 years ago)
• Last Synced: 2024-08-09T02:19:56.246Z (8 months ago)
• Homepage:
• Size: 734 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - insanum/py-trello - Python API wrapper around Trello's API (Others)

README

        
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 `_).

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 ./trello/util.py`

Required Python modules

=======================

Found in requirements.txt

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 `_

* `Kyle Valade `_