Metadata-Version: 2.1
Name: tkapi
Version: 0.8.0.dev3
Summary: Python bindings for the Tweede Kamer OData API
Home-page: https://github.com/openkamer/tkapi
Author: Open Kamer
Author-email: info@openkamer.org
License: MIT
Description: # tkapi
        [![PyPI version](https://badge.fury.io/py/tkapi.svg)](https://badge.fury.io/py/tkapi)  
        Python bindings for the [Tweede Kamer](https://tweedekamer.nl) [Open Data Portaal](https://opendata.tweedekamer.nl) OData API.
        
        Requires Python 3.5+
        
        You are welcome to open an issue if you have any problems, questions or suggestions.
        
        ## Installation
        ```
        pip install tkapi
        ```
        
        ## Authentication
        You need to whitelist your IP by registering at https://opendata.tweedekamer.nl.
        
        ## Usage
        A simple first example,
        ```python
        import tkapi
        
        api = tkapi.Api()
        personen = api.get_personen(max_items=100)
        for persoon in personen:
            print(persoon.achternaam)
        ```
        
        For more examples see the `examples` directory and the tests.
        
        ## Entities
        **Bold** entities are implemented.
        
        |                            |                            |                              |
        |----------------------------|----------------------------|------------------------------|
        | **Activiteit**             | **Commissie**              | **Persoon**                  |
        | ActiviteitActor            |                            | PersoonAdres                 |
        | **Zaak**                   |                            | PersoonContactinformatie     |
        | ZaakActor                  | **CommissieZetel**         | **PersoonGeschenk**          |
        | **Kamerstukdossier**       | **CommissieVastPersoon**   | **PersoonLoopbaan**          |
        | **Fractie**                | **CommissieVervangerPersoon** | **PersoonNevenfunctie**      |
        |                            | CommissieVastVacature      | **PersoonNevenfunctieInkomsten** |
        | FractieAanvullendGegeven   | CommissieVervangerVacature | **PersoonOnderwijs**         |
        | **FractieZetel**           |                            | **PersoonReis**              |
        | **Stemming**               |                            | **PersoonFunctie**           |
        | Zaal                       |                            |                              |
        | Reservering                |                            |                              |
        | **Vergadering**            |                            |                              |
        | **Document**               |                            |                              |
        | DocumentVersie             |                            |                              |
        | Bestand                    |                            |                              |
        | **Agendapunt**             |                            |                              |
        | **Besluit**                |                            |                              |
        
        ## Development
        
        ### Tests
        
        Run all tests,
        ```bash
        python -m unittest discover
        ```
        
        #### Coverage report
        
        Run all tests,
        ```bash
        coverage run -m unittest discover
        ```
        
        Create coverage report,
        ```bash
        coverage html
        ```
        Then visit htmlcov/index.html in your browser.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
