{ "info": { "author": "Jeff Slort", "author_email": "j_slort@hotmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Office/Business", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "# OpenKVK: API wrapper\n[![pypi](http://img.shields.io/pypi/v/OpenKVK.svg)](https://pypi.python.org/pypi/OpenKVK/)\n[![Build Status](https://travis-ci.org/jeff-99/OpenKVK.svg?branch=development)](https://travis-ci.org/jeff-99/OpenKVK)\n[![License](http://img.shields.io/pypi/l/OpenKVK.svg)](https://pypi.python.org/pypi/OpenKVK/)\n## What is it ?\n\nOpenKVK is an UNOFFICIAL python wrapper for the [openkvk API](https://openkvk.nl/api.html)\n\n## Main Features\na few of the things this library does well:\n\n- Get dutch company information by name or kvk-number\n- Get lists of companies based on sbi-codes, location or both\n- Output information in `json`, `csv` or `dict`\n- Wrap your own queries with or without result parsing\n\n## Command line interface\nFor quick access to the openkvk api you could use the OpenKVK CLI, like so:\n\n```sh\nopenkvk --help\nopenkvk --kvk 27312152 --format json --output test.json\n```\n\n## Installation\nThe source code is currently hosted on GitHub at:\nhttp://github.com/jeff-99/OpenKVK\n\nInstall via `pip`:\n\n```sh\npip install OpenKVK\n```\n\nAnd via `easy_install`:\n\n```sh\neasy_install OpenKVK\n```\n\n## Example\n\nFirst you need to instantiate a OpenKVK client\n```python\nfrom OpenKVKimport ApiClient\n\nclient = ApiClient()\n\n```\nThe Client returns data as python dicts, to change this output format.\nyou could do one of the following\n\n```python\nclient = ApiClient('json')\n```\nOR\n```python\nclient.setResponseFormat('json')\n```\n\nThe client can then be used to query by using the following:\n\n```python\nclient.get_by_kvk(53012321)\nclient.get_by_city('Rotterdam')\nclient.get_by_name('KPN')\nclient.get_by_sbi('06.10')\n```\n\nThe `city`, `name` and `sbi` functions also accept a maximum number of results (defaults to 99)\nand a additional filters, like:\n\n```python\nclient.get_by_sbi('06.10',limit=150, plaats=\"Rotterdam\")\n```\n\nfor a full list of available filters check [openkvk](https://www.openkvk.nl/api.html)\n\nIf you like to construct you own SQL-queries and you like the results to be parsed to a valid JSON array, a python list of dicts or a valid csv\nyou could use the `QueryBuilder` class.\n\n```python\nfrom OpenKVK import QueryBuilder\n\nclient = QueryBuilder()\nclient.setResponseFormat('csv')\nclient.query(\"SELECT * FROM kvk WHERE kvks = 27312152\")\n```\n\nIf you don't want the parsed results there is also a very minimalistic api client\n\n```python\nfrom OpenKVK import BaseClient\n\nclient = BaseClient()\nclient.setResponseFormat('py')\nclient.query(\"SELECT * FROM kvk WHERE kvks = 27312152\")\n```\n\n## License\nMIT\n\n\n\nVersion 0.4\n-----------\n\n- Bugfix QueryBuilder limiter\n\nVersion 0.3\n-----------\n\n- Added python 3 support\n- Fixxed additional filters\n- Updated documentation\n\nVersion 0.2\n-----------\n\n- Added Commandline interface\n- Added method for querying bankruptcies\n- Added tests\n- Added MANIFEST.in\n- Restructured classes\n- Fixed csv output\n- Fixed get_by_kvk() method\n\nVersion 0.1\n-----------\n\nFirst public preview release.", "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/jeff-99/OpenKVK", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "OpenKVK", "package_url": "https://pypi.org/project/OpenKVK/", "platform": "any", "project_url": "https://pypi.org/project/OpenKVK/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/jeff-99/OpenKVK" }, "release_url": "https://pypi.org/project/OpenKVK/0.4/", "requires_dist": null, "requires_python": null, "summary": "Python API wrapper for the OpenKVK service", "version": "0.4" }, "last_serial": 1216732, "releases": { "0.1": [], "0.2": [ { "comment_text": "", "digests": { "md5": "b02db37eb7b33e292fc6460a0ec20661", "sha256": "c932dd52236f167005134178dba75f49c83c7fdb681013265f0ec83e61bb48bd" }, "downloads": -1, "filename": "OpenKVK-0.2.zip", "has_sig": false, "md5_digest": "b02db37eb7b33e292fc6460a0ec20661", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 384173, "upload_time": "2014-07-22T15:22:54", "url": "https://files.pythonhosted.org/packages/d5/c3/4af10c6eab74d6c047a66aece2061b000be8aec393303daa3efa64e1b94f/OpenKVK-0.2.zip" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "2176f3e01dd9eeaa705fb4379c26f75c", "sha256": "764a997fe692de0c80596c1245750a7dfb497603ce1333ddf004d578754fe085" }, "downloads": -1, "filename": "OpenKVK-0.3.zip", "has_sig": false, "md5_digest": "2176f3e01dd9eeaa705fb4379c26f75c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 377386, "upload_time": "2014-07-23T18:44:30", "url": "https://files.pythonhosted.org/packages/e1/50/1c3e669812a8a7ebc3a04e1d0b9489ab65364130ce63d14b5f2e25bf8e36/OpenKVK-0.3.zip" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "d83a89d367f3b2f22418d4719883e426", "sha256": "92e3b7bfc3fa0d34c7a2235841770df64e0a382fd817329dc26031459ccdd066" }, "downloads": -1, "filename": "OpenKVK-0.4.zip", "has_sig": false, "md5_digest": "d83a89d367f3b2f22418d4719883e426", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 377234, "upload_time": "2014-09-08T08:30:05", "url": "https://files.pythonhosted.org/packages/2e/42/36a2889fc7ee3bc080c5afdf6f425d8bdeb1d67e2186467b9186fbb49073/OpenKVK-0.4.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d83a89d367f3b2f22418d4719883e426", "sha256": "92e3b7bfc3fa0d34c7a2235841770df64e0a382fd817329dc26031459ccdd066" }, "downloads": -1, "filename": "OpenKVK-0.4.zip", "has_sig": false, "md5_digest": "d83a89d367f3b2f22418d4719883e426", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 377234, "upload_time": "2014-09-08T08:30:05", "url": "https://files.pythonhosted.org/packages/2e/42/36a2889fc7ee3bc080c5afdf6f425d8bdeb1d67e2186467b9186fbb49073/OpenKVK-0.4.zip" } ] }