.. OpenAustralia API Python Client documentation master file, created by sphinx-quickstart on Mon Dec 15 00:57:40 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. OpenAustralia API -- Python Client ================================== Contents: .. toctree:: :maxdepth: 2 api Overview -------- .. image:: https://drone.io/bitbucket.org/otherchirps/openaustralia-api-py/status.png :target: https://drone.io/bitbucket.org/otherchirps/openaustralia-api-py/latest This is a python wrapper for the `OpenAustralia API `_. NOTE: This isn't officially affiliated with the `OpenAustralia `_ project. It's just something I'm playing around with. Suggestions / contributions towards making this more useful are welcome. Documentation ------------- You can find the package documentation :doc:`here `. Installation ------------ From source ~~~~~~~~~~~ ``python setup.py install`` pip ~~~ ``pip install openaustralia`` Usage ----- .. code-block:: python from openaustralia import OpenAustralia oa = OpenAustralia("YOUR KEY") search = oa.get_hansard("barnacles") search['rows'].pop(0) Source code ----------- You can get the code here: https://bitbucket.org/otherchirps/openaustralia-api-py Testing ------- `tox `_ is being used to run the tests across python 2.7 & 3.x. To bootstrap your test environment, the easiest way is you use the `pip `_ requirements file:: pip install -r requirements.txt Then you can simply run:: tox Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`