Python bindings for the Tweede Kamer OData API
Project 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 | CommissieOrganisatie | PersoonAdres |
| **Zaak** | CommissieAanvullendGegeven | PersoonContactinformatie |
| ZaakActor | **CommissieZetel** | **PersoonGeschenk** |
| **Kamerstukdossier** | **CommissieVastPersoon** | **PersoonLoopbaan** |
| **Fractie** | CommissieVastVacature | **PersoonNevenfunctie** |
| | CommissieVervangerVacature | **PersoonNevenfunctieInkomsten** |
| FractieAanvullendGegeven | CommissieVervangerPersoon | **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.
[![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 | CommissieOrganisatie | PersoonAdres |
| **Zaak** | CommissieAanvullendGegeven | PersoonContactinformatie |
| ZaakActor | **CommissieZetel** | **PersoonGeschenk** |
| **Kamerstukdossier** | **CommissieVastPersoon** | **PersoonLoopbaan** |
| **Fractie** | CommissieVastVacature | **PersoonNevenfunctie** |
| | CommissieVervangerVacature | **PersoonNevenfunctieInkomsten** |
| FractieAanvullendGegeven | CommissieVervangerPersoon | **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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tkapi-0.8.0.dev1.tar.gz
(13.5 kB
view hashes)
Built Distribution
tkapi-0.8.0.dev1-py3-none-any.whl
(23.5 kB
view hashes)
Close
Hashes for tkapi-0.8.0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f19b10472c5b881dfbc31e9cad435d5b05538f256ce348b4031c14d35eeb6cd0 |
|
MD5 | 194b862d21fa588838c55a5715bc35bf |
|
BLAKE2b-256 | c932a5177a0bba4baec9874f6c58b53bbc6ce3b9e600e18892022823ebfb5c58 |