Python bindings and ORM for the Tweede Kamer OData API
Project description
tkapi
Python ORM and bindings for the Tweede Kamer Open Data Portaal OData API.
A pure Python interface for the Tweede Kamer API with type annotations for easy data model discovery.
Requires Python 3.5+.
Please create 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.
Data model
See Open Kamer Data Model documentation for the data model that is mapped to Python classes.
Usage
A simple first example,
import tkapi
api = tkapi.TKApi()
personen = api.get_personen(max_items=100)
for persoon in personen:
print(persoon.achternaam)
For more examples see the examples and tests.
Entities
See Tweede Kamer documentation for details.
Algemeen | Persoon | Fractie | Commissie |
---|---|---|---|
Activiteit | Persoon | Fractie | Commissie |
ActiviteitActor | PersoonContactinformatie | FractieAanvullendGegeven | CommissieContactinformatie |
Agendapunt | PersoonFunctie | FractieZetel | CommissieZetel |
Besluit | PersoonGeschenk | FractieZetelPersoon | CommissieZetelVastPersoon |
Document | PersoonLoopbaan | FractieZetelVacature | CommissieZetelVastVacature |
DocumentActor | PersoonNevenfunctie | CommissieZetelVervangerPersoon | |
DocumentVersie | PersoonNevenfunctieInkomsten | CommissieZetelVervangerVacature | |
Kamerstukdossier | PersoonOnderwijs | ||
Reservering | PersoonReis | ||
Stemming | |||
Vergadering | |||
Verslag | |||
Zaak | |||
ZaakActor | |||
Zaal |
Development
Tests
Run all tests,
python -m unittest discover
Coverage report
Run all tests,
coverage run -m unittest discover
Create coverage report,
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.