Metadata-Version: 2.1
Name: kvk-api-client
Version: 0.0.10
Summary: Simple python wrapper for KVK api
Home-page: UNKNOWN
Author: Ugurcan Akpulat
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: python-dotenv (>=0.21.1)
Requires-Dist: requests (>=2.28.2)
Requires-Dist: aiohttp (>=3.8.5)
Provides-Extra: dev
Requires-Dist: pytest (==7.2.1) ; extra == 'dev'
Requires-Dist: pytest-asyncio (==0.21.1) ; extra == 'dev'

# KVK API Client

This is a Python client for the KVK API, which provides access to the Dutch Chamber of Commerce (KVK) company register.

## Installation

You can install the package into your project via pip:

```sh
pip install kvk_api_client
```

# USAGE

To use the KVK API client, you first need to set up environment variables for the required credentials:

```sh
export KVK_HOST='https://api.kvk.nl'
export KVK_API_VERSION='api/v1'
export KVK_APIKEY_TEST='your-test-api-key'
export KVK_APIKEY_PROD='your-production-api-key'
```

# EXAMPLE

By setting the test parameter to true, you can play arround with api:
https://developers.kvk.nl/documentation/testing

```python
from kvk_api_client import KVK

# Create a KVK API client instance
kvk = KVK(test=True)

KVK_NUMBER = "68750110"

# Call an API method
companies = kvk.get_companies(kvk_number=KVK_NUMBER)
```

# TESTS

Make sure pytest is installed on your environment

```sh
python3 -m pytest
```

# KVK API Asycn Client

```python
import asyncio
from kvk_api_client import AsyncKVK


KVK_NUMBER = "68750110"


async def get_basis_profiel():
    async with AsyncKVK(test=True) as kvk:
        profiel = await kvk.get_basis_profiel(KVK_NUMBER)
        print(await profiel.json())


asyncio.run(get_basis_profiel())

```

# Repo
[KVK WRAPPER](https://github.com/macukadam/kvk_api_wrapper)


