BigDoor Client
==============
This is a Python client library for the `BigDoor API`_.
.. _BigDoor API: http://www.bigdoor.com/
Basic Usage
-----------
The ``bigdoorkit`` client requires your keys as provided by BigDoor::
>>> from bigdoorkit import Client
>>> client = Client(app_secret, app_key)
>>> currency_types = client.get('currency_type')
>>> from pprint import pprint
>>> pprint(currency_types)
[[{u'can_be_cross_publisher': 0,
u'can_be_purchased': 1,
u'can_be_rewarded': 0,
u'created_timestamp': 1263933875,
u'description': None,
u'has_dollar_exchange_rate_integrity': 1,
u'id': 1,
u'modified_timestamp': 1263933875,
u'read_only': 0,
u'resource_name': u'currency_type',
u'title': u'Purchase'},
{u'can_be_cross_publisher': 0,
u'can_be_purchased': 0,
u'can_be_rewarded': 1,
u'created_timestamp': 1263933875,
u'description': None,
u'has_dollar_exchange_rate_integrity': 0,
u'id': 2,
u'modified_timestamp': 1263933875,
u'read_only': 0,
u'resource_name': u'currency_type',
u'title': u'Reward'},
{u'can_be_cross_publisher': 0,
u'can_be_purchased': 1,
u'can_be_rewarded': 1,
u'created_timestamp': 1263933875,
u'description': u'',
u'has_dollar_exchange_rate_integrity': 0,
u'id': 3,
u'modified_timestamp': 1264002256,
u'read_only': 0,
u'resource_name': u'currency_type',
u'title': u'Hybrid'},
{u'can_be_cross_publisher': 1,
u'can_be_purchased': 0,
u'can_be_rewarded': 0,
u'created_timestamp': 1263933875,
u'description': None,
u'has_dollar_exchange_rate_integrity': 1,
u'id': 4,
u'modified_timestamp': 1263933875,
u'read_only': 0,
u'resource_name': u'currency_type',
u'title': u'\xdcber'}],
{}]
Known Issues
------------
* The ``resource`` module is under heavy development and should not be used for now.
* Very little formal documentation.
* Unit tests are sparse.
News
====
0.1.3
-----
*Release date: 29-Jul-2010*
* Some progress on the resource module
* Fixed deprecation warning from RESTkit
* Requests no longer modify params/payload dicts in place, using a copy to build the request. This prevents the original dicts from being filled with request specific data (auto-generated token, time, etc).
0.1.2
-----
*Release date: 23-Jun-2010*
* DELETE methods now automatically add the `delete_token` parameter.
* DELETE methods no longer try to decode the JSON response as the BigDoor API returns `204 NO CONTENT`.
0.1.1
-----
*Release date: 18-Jun-2010*
* Improved docstrings.
* Removed hard coded logging to client_log.txt.
0.1
---
*Release date: 10-Jun-2010*
* Initial release.
