The BigBen Python client library

This client library simplifies accessing BigBen's APIs. The library provides easy ways to store your authentication and create JSON web service clients. It also contains example code to help you get started integrating with our APIs.

How do I get started?

Installing the library

Install or update the library from PyPI. If you're using pip, this is as easy as:

$ pip install [--upgrade] bigben-python-lib

You can find code examples in the git repo and in the library's releases within the examples folder.

Where can I find the pydocs?

Our pydocs are hosted at: http://sgiroux.github.io/bigben-python-lib

Where do I submit bug reports and/or feature requests?

If you have issues directly related to the client library, use the issue tracker.

How do I log JSON interactions?

The library uses Python's built in logging framework. If you wish to log your JSON interactions to stdout, you can do the following:

logging.basicConfig(level=logging.INFO)
logging.getLogger('bigben.transport').setLevel(logging.DEBUG)

If you wish to log to a file, you'll need to attach a log handler to this source which is configured to write the output to a file.

Authors:

Sam Giroux