Asynchronous Python client for the open datasets of Eindhoven (The Netherlands).
A python package with which you can retrieve data from the Open Data Platform of Eindhoven via their API. This package was initially created to only retrieve parking data from the API, but the code base is made in such a way that it is easy to extend for other datasets from the same platform.
pip install eindhoven
You can read the following datasets with this package:
Click here to get more details
You can use the following parameters in your request:
- limit (default: 10) - How many results you want to retrieve.
- parking_type (default: ParkingType.PARKING) - See the list below to find the corresponding enum value.
ParkingType |
Enum |
---|---|
Parkeerplaats | PARKING |
Parkeerplaats Vergunning | PERMIT_PARKING |
Parkeerplaats Gehandicapten | DISABLED_PARKING |
Parkeerplaats Afgekruist | CROSSED_OUT_PARKING |
Parkeerplaats laden/lossen | LOADING_UNLOADING_PARKING |
Parkeerplaats Electrisch opladen | ELECTRIC_CHARGING_PARKING |
You get the following output data back with this dataset:
Attribute | Type | Description |
---|---|---|
spot_id |
string | The id of the parking spot |
data |
ParkingData | The parking data of the parking spot |
geometry |
Geometry | The geometry of the parking spot |
updated_at |
datetime | When this parking spot was updated in the dataset |
The parking data of the parking spot.
Attribute | Type | Description |
---|---|---|
parking_type |
string | The type of parking of the parking spot |
street |
string | The street name where this parking spot is located |
number |
int | The number of parkings spots on this location |
The geometry of the parking spot is a GeoJSON object. The coordinates are in the WGS84 coordinate system.
Attribute | Type | Description |
---|---|---|
coordinates |
list | The coordinates of the parking spot |
longitude |
float | The longitude of the parking spot |
latitude |
float | The latitude of the parking spot |
import asyncio
from eindhoven import ODPEindhoven, ParkingType
async def main() -> None:
"""Show example on using the Open Data Platform API of Eindhoven."""
async with ODPEindhoven() as client:
locations = await client.locations(
limit=100,
parking_type=ParkingType.PARKING,
)
print(locations)
if __name__ == "__main__":
asyncio.run(main())
A website that provides insight into where disabled parking spaces are, based on data from users and municipalities. Operates mainly in the Netherlands, but also has plans to process data from abroad.
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We've set up a separate document for our contribution guidelines.
Thank you for being involved! π
The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.
This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.
You need at least:
- Python 3.11+
- Poetry
Install all packages, including all development requirements:
poetry install
Poetry creates by default an virtual environment where it installs all necessary pip packages.
This repository uses the pre-commit framework, all changes are linted and tested with each commit. To setup the pre-commit check, run:
poetry run pre-commit install
And to run all checks and tests manually, use the following command:
poetry run pre-commit run --all-files
It uses pytest as the test framework. To run the tests:
poetry run pytest
To update the syrupy snapshot tests:
poetry run pytest --snapshot-update
MIT License
Copyright (c) 2021-2024 Klaas Schoute
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.