{ "info": { "author": "James Gardiner", "author_email": "jamesg87@me.com", "bugtrack_url": null, "classifiers": [ "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "[![Build Status](https://travis-ci.org/JamesGardiner/chwrapper.svg?branch=master)](https://travis-ci.org/JamesGardiner/companies-house)\n[![Coverage Status](https://coveralls.io/repos/github/JamesGardiner/chwrapper/badge.svg?branch=master)](https://coveralls.io/github/JamesGardiner/chwrapper?branch=master)\n# chwrapper\nA python wrapper around the [Companies House UK API](https://developer.companieshouse.gov.uk/api/docs/). Returns [requests.Response objects](http://docs.python-requests.org/en/latest/api/#requests.Response).\n\n## Example usage\n\n```python\n>>> import chwrapper\n>>> search_client = chwrapper.Search(access_token='secret_token')\n>>> response = search_client.search_companies('dyson')\n>>> response.json()\n{'items': [{'address': {'address_line_1': 'Malmesbury',\n 'locality': 'Wiltshire',\n 'postal_code': 'SN16 0RP',\n 'premises': 'Tetbury Hill'},\n 'address_snippet': 'Tetbury Hill, Malmesbury, Wiltshire, SN16 0RP',\n 'company_number': '03772814',\n 'company_status': 'active',\n 'company_type': 'ltd',\n 'date_of_creation': '1999-05-18',\n 'description': '03772814 - Incorporated on 18 May 1999',\n 'description_identifier': ['incorporated-on'],\n 'kind': 'searchresults#company',\n 'links': {'self': '/company/03772814'},\n 'matches': {'snippet': [1, 5, 20, 24], 'title': [1, 5]},\n 'snippet': 'DYSON TECHNOLOGY \u00b7 DYSON ',\n 'title': 'DYSON JAMES LIMITED'},...]}\n```\n\nFor further details, see the docs:\n\nhttp://chwrapper.readthedocs.org/en/latest/\n\n## Supported Endpoints\n- [**Search for companies by name**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.search_companies)\n\n- [**Search for officers by name**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.search_officers)\n\n- [**Search for officer appointments by officer number**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.appointments)\n\n- [**Search for company addresses by company number**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.address)\n\n- [**Search for company profile by company number**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.profile)\n\n- [**Search for insolvency records by company number**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.insolvency)\n\n- [**Search for a company's filing history**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.filing_history)\n\n- [**Search for charges against a company**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.charges)\n\n- [**Search for officers registered against a company**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.officers)\n\n- [**Search for disqualified officers by their ID number**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.disqualified)\n\n- [**Search for all persons of significant control of a company**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.persons_significant_control)\n\n- [**Search for a single person with significant control of a company**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.significant_control)\n\n- [**Search for documents by document ID**] (http://chwrapper.readthedocs.io/en/latest/user/api.html#chwrapper.Search.documents)\n\n## Installation\n\n### Get the Code\nchwrapper is available on [PyPi](https://pypi.python.org/pypi/chwrapper/0.2.0). Just `pip install chwrapper`.\n\nchwrapper is also available on [GitHub](https://github.com/JamesGardiner/chwrapper).\n\nYou can either clone the public repository:\n```bash\n$ git clone git://github.com/JamesGardiner/chwrapper.git\n```\nDownload the [tarball](https://github.com/nestauk/gtr/tarball/master)\n```bash\n$ curl -OL https://github.com/JamesGardiner/chwrapper/tarball/master\n```\nOr, download the zipball:\n```bash\n$ curl -OL https://github.com/nestauk/gtr/zipball/master\n```\nOnce you have a copy of the source, you can install it into your Python package, or install it into your site-packages easily:\n```bash\n$ python setup.py install\n```", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/jamesgardiner/chwrapper", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "chwrapper", "package_url": "https://pypi.org/project/chwrapper/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/chwrapper/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/jamesgardiner/chwrapper" }, "release_url": "https://pypi.org/project/chwrapper/0.3.0/", "requires_dist": null, "requires_python": null, "summary": "A simple wrapper around the Companies House API", "version": "0.3.0" }, "last_serial": 2502875, "releases": { "0.0.1": [], "0.1": [ { "comment_text": "", "digests": { "md5": "07b95f4cd90c09a244d67ce67b44f89f", "sha256": "509673bfb71d85921f94c89ee778417a16dd18aa4a6764bc9379a60728de1e2e" }, "downloads": -1, "filename": "chwrapper-0.1.tar.gz", "has_sig": false, "md5_digest": "07b95f4cd90c09a244d67ce67b44f89f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2148, "upload_time": "2016-01-27T16:25:53", "url": "https://files.pythonhosted.org/packages/73/f9/7fcd56c7e5dd9a30016fa8a0a62e1ce75b27241f2d250b6af630b26f0086/chwrapper-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6ebe7e4c49924d2e0acfbda9e1d16b9e", "sha256": "056429e8c195a6c76c0175e1468717e73a2e80205931345dc0dda85a7da7bab1" }, "downloads": -1, "filename": "chwrapper-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6ebe7e4c49924d2e0acfbda9e1d16b9e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5536, "upload_time": "2016-01-27T20:53:55", "url": "https://files.pythonhosted.org/packages/e4/ee/3daf8e4df70634ad7659002d36c96930b53592791b545500ac1eecc0c99a/chwrapper-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "039bb71d8268b07cd065d5fe54d223ee", "sha256": "1f099715ee103741c7762f2f4fdd4050a44cf90f0b73f9f68e692328f57aa677" }, "downloads": -1, "filename": "chwrapper-0.2.0-py2-none-any.whl", "has_sig": false, "md5_digest": "039bb71d8268b07cd065d5fe54d223ee", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 9130, "upload_time": "2016-04-22T11:34:33", "url": "https://files.pythonhosted.org/packages/1c/10/3f80d022f6edebd8a5b8b7070c19f263e3ec8dcc1d8b44bc059f66cd8d08/chwrapper-0.2.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0457f62eb022185fd6c40b2e0af619c0", "sha256": "819a6e34d6372d2921753dcb488b5c503fc21cabbed6f099c9616f45de15a014" }, "downloads": -1, "filename": "chwrapper-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "0457f62eb022185fd6c40b2e0af619c0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9131, "upload_time": "2016-04-22T11:14:50", "url": "https://files.pythonhosted.org/packages/ae/ec/45f1d64ecd1f2e371c26127575fd79bec2293721c153b1c24876bf253ec0/chwrapper-0.2.0-py3-none-any.whl" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "8dfd1a4deb342014785a66265e494e46", "sha256": "0f27da01ccbc1fe5e9e8a313bb94939ede1b88c83916a5e278a24d6c8c218700" }, "downloads": -1, "filename": "chwrapper-0.3.0.tar.gz", "has_sig": false, "md5_digest": "8dfd1a4deb342014785a66265e494e46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8757, "upload_time": "2016-12-06T16:34:23", "url": "https://files.pythonhosted.org/packages/af/20/b81c836c66b1061f26ae77d7432c5ad10fabc1d5702dba8eb452d027eeb3/chwrapper-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8dfd1a4deb342014785a66265e494e46", "sha256": "0f27da01ccbc1fe5e9e8a313bb94939ede1b88c83916a5e278a24d6c8c218700" }, "downloads": -1, "filename": "chwrapper-0.3.0.tar.gz", "has_sig": false, "md5_digest": "8dfd1a4deb342014785a66265e494e46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8757, "upload_time": "2016-12-06T16:34:23", "url": "https://files.pythonhosted.org/packages/af/20/b81c836c66b1061f26ae77d7432c5ad10fabc1d5702dba8eb452d027eeb3/chwrapper-0.3.0.tar.gz" } ] }