chwrapper
A python wrapper around the Companies House UK API. Returns requests.Response objects.
Example usage
>>> import chwrapper
>>> search_client = chwrapper.Search(access_token='secret_token')
>>> response = search_client.search_companies('dyson')
>>> response.json()
{'items': [{'address': {'address_line_1': 'Malmesbury',
'locality': 'Wiltshire',
'postal_code': 'SN16 0RP',
'premises': 'Tetbury Hill'},
'address_snippet': 'Tetbury Hill, Malmesbury, Wiltshire, SN16 0RP',
'company_number': '03772814',
'company_status': 'active',
'company_type': 'ltd',
'date_of_creation': '1999-05-18',
'description': '03772814 - Incorporated on 18 May 1999',
'description_identifier': ['incorporated-on'],
'kind': 'searchresults#company',
'links': {'self': '/company/03772814'},
'matches': {'snippet': [1, 5, 20, 24], 'title': [1, 5]},
'snippet': 'DYSON TECHNOLOGY · DYSON ',
'title': 'DYSON JAMES LIMITED'},...]}
For further details, see the docs:
http://chwrapper.readthedocs.org/en/latest/
Supported Endpoints
Installation
Get the Code
chwrapper is available on PyPi. Just pip install chwrapper
.
chwrapper is also available on GitHub.
You can either clone the public repository:
$ git clone git://github.com/JamesGardiner/chwrapper.git
Download the tarball
$ curl -OL https://github.com/JamesGardiner/chwrapper/tarball/master
Or, download the zipball:
$ curl -OL https://github.com/nestauk/gtr/zipball/master
Once you have a copy of the source, you can install it into your Python package, or install it into your site-packages easily:
$ python setup.py install