Metadata-Version: 1.1
Name: OpenKVK
Version: 0.4
Summary: Python API wrapper for the OpenKVK service
Home-page: http://github.com/jeff-99/OpenKVK
Author: Jeff Slort
Author-email: j_slort@hotmail.com
License: MIT
Description: # OpenKVK: API wrapper
        [![pypi](http://img.shields.io/pypi/v/OpenKVK.svg)](https://pypi.python.org/pypi/OpenKVK/)
        [![Build Status](https://travis-ci.org/jeff-99/OpenKVK.svg?branch=development)](https://travis-ci.org/jeff-99/OpenKVK)
        [![License](http://img.shields.io/pypi/l/OpenKVK.svg)](https://pypi.python.org/pypi/OpenKVK/)
        ## What is it ?
        
        OpenKVK is an UNOFFICIAL python wrapper for the [openkvk API](https://openkvk.nl/api.html)
        
        ## Main Features
        a few of the things this library does well:
        
        - Get dutch company information by name or kvk-number
        - Get lists of companies based on sbi-codes, location or both
        - Output information in `json`, `csv` or `dict`
        - Wrap your own queries with or without result parsing
        
        ## Command line interface
        For quick access to the openkvk api you could use the OpenKVK CLI, like so:
        
        ```sh
        openkvk --help
        openkvk --kvk 27312152 --format json --output test.json
        ```
        
        ## Installation
        The source code is currently hosted on GitHub at:
        http://github.com/jeff-99/OpenKVK
        
        Install via `pip`:
        
        ```sh
        pip install OpenKVK
        ```
        
        And via `easy_install`:
        
        ```sh
        easy_install OpenKVK
        ```
        
        ## Example
        
        First you need to instantiate a OpenKVK client
        ```python
        from OpenKVKimport ApiClient
        
        client = ApiClient()
        
        ```
        The Client returns data as python dicts, to change this output format.
        you could do one of the following
        
        ```python
        client = ApiClient('json')
        ```
        OR
        ```python
        client.setResponseFormat('json')
        ```
        
        The client can then be used to query by using the following:
        
        ```python
        client.get_by_kvk(53012321)
        client.get_by_city('Rotterdam')
        client.get_by_name('KPN')
        client.get_by_sbi('06.10')
        ```
        
        The `city`, `name` and `sbi` functions also accept a maximum number of results (defaults to 99)
        and a additional filters, like:
        
        ```python
        client.get_by_sbi('06.10',limit=150, plaats="Rotterdam")
        ```
        
        for a full list of available filters check [openkvk](https://www.openkvk.nl/api.html)
        
        If 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
        you could use the `QueryBuilder` class.
        
        ```python
        from OpenKVK import QueryBuilder
        
        client = QueryBuilder()
        client.setResponseFormat('csv')
        client.query("SELECT * FROM kvk WHERE kvks = 27312152")
        ```
        
        If you don't want the parsed results there is also a very minimalistic api client
        
        ```python
        from OpenKVK import BaseClient
        
        client = BaseClient()
        client.setResponseFormat('py')
        client.query("SELECT * FROM kvk WHERE kvks = 27312152")
        ```
        
        ## License
        MIT
        
        
        
        Version 0.4
        -----------
        
        - Bugfix QueryBuilder limiter
        
        Version 0.3
        -----------
        
        - Added python 3 support
        - Fixxed additional filters
        - Updated documentation
        
        Version 0.2
        -----------
        
        - Added Commandline interface
        - Added method for querying bankruptcies
        - Added tests
        - Added MANIFEST.in
        - Restructured classes
        - Fixed csv output
        - Fixed get_by_kvk() method
        
        Version 0.1
        -----------
        
        First public preview release.
Platform: any
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Office/Business
