Metadata-Version: 1.0
Name: trollop
Version: 0.0.2
Summary: A Python library for working with the Trello api.
Home-page: http://bits.btubbs.com/trollop
Author: Brent Tubbs
Author-email: brent.tubbs@gmail.com
License: UNKNOWN
Description: Meet Trollop
        ============
        
        Trollop is a Python library for working with the `Trello API`_.
        
        Quick Start
        ===========
        
        A Trello connection is instantiated with your `API key`_ and a user's `oauth token`_::
        
            In [1]: from trollop import TrelloConnection
        
            In [2]: conn = TrelloConnection(<your developer key>, <user's oauth token>)
        
        The connection object will automatically have a Member object attached,
        representing the user whose oauth token was used to connect::
        
            In [3]: conn.me
            Out[3]: <trollop.lib.Member object at 0x101707650>
        
            In [4]: conn.me.username
            Out[4]: u'btubbs'
        
        In the previous example no HTTP request was made until command 4, the access
        to conn.me.username.  Trollop objects are lazy.
        
        The connection object has methods for getting objects by their IDs.  The
        objects will have attributes named exactly as they are in the Trello API docs.::
        
            In [5]: card = conn.get_card('4f2e454cefab2bbd4ea71b02')
        
            In [6]: card.name
            Out[6]: u'Build a Python Trello Library'
        
            In [7]: card.desc
            Out[7]: u'And call it Trollop.'
        
            In [8]: card.idList
            Out[8]: u'4f17cb04d5c817032301c179' 
        
        In addition, there are convenience properties to automatically look up related
        objects.::
        
            In [9]: lst = card.list
        
            In [10]: lst
            Out[10]: <trollop.lib.List object at 0x101707890>
        
            In [11]: lst.name
            Out[11]: u'Icebox'
        
            In [12]: lst.id
            Out[12]: u'4f17cb04d5c817032301c179'
        
            In [13]: len(lst.cards)
            Out[13]: 20
        
            In [14]: lst.cards[-1].name
            Out[14]: u'Build a Python Trello Library'
        
        Help Wanted
        ===========
        
        Some objects are not yet implemented (e.g. actions), as well as some relations
        between objects.  They're easy to add though; just take a look at the
        already-implemented classes in trollop/lib.py to see how to declare a new
        class, attribute, or relation.  If you'd like to pitch in to finish covering
        the whole API, please send a pull request with your changes.
        
        License
        =======
        
        Trollop is licensed under the `MIT License`_.
        
        .. _Trello API: https://trello.com/docs/api/index.html
        .. _API key: https://trello.com/card/board/generating-your-developer-key/4ed7e27fe6abb2517a21383d/4eea75831576578f2713f460
        .. _oauth token: https://trello.com/card/board/getting-a-user-token-and-oauth-urls/4ed7e27fe6abb2517a21383d/4eea75bc1576578f2713fc5f 
        .. _MIT License: http://www.opensource.org/licenses/mit-license.php
        
Platform: UNKNOWN
