README.md

Asynchronous Python client for the open datasets of Dusseldorf (Germany).

About

A python package with which you can retrieve data from the Open Data Platform of Dusseldorf 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.

Installation

pip install dusseldorf

Datasets

You can read the following datasets with this package:

• Disabled parking spaces / allgemeinen Behindertenparkplätze (315)
• Park and rides locations / Park + Ride Anlagen (35)
• Garage locations / Parkhäuser (55)

There are a number of parameters you can set to retrieve the data:

• limit (default: 10) - How many results you want to retrieve.

Click here to get more details

Disabled parking spaces

Variable	Type	Description
entry_id	string	The ID of the parking spot
number	integer	The number of parking spots on this location
address	string	The address of the parking spot
district	string	The district location of the parking spot
time_limit	string	Some locations have window times where the location is only specific for disabled parking, outside these times everyone is allowed to park there
note	string	Some locations have a note about the parking spot
longitude	float	The longitude of the parking spot
latitude	float	The latitude of the parking spot
last_update	datetime	The last time the data was updated

Park and Rides

Variable	Type	Description
entry_id	integer	The ID of the park and ride
name	string	The name of the park and ride
address	string	The address of the park and ride
district	integer	The district number of the park and ride
neighbourhood	string	The neighbourhood of the park and ride
public_transport	string	The public transport lines that is nearby
longitude	float	The longitude of the park and ride
latitude	float	The latitude of the park and ride

Garages

Variable	Type	Description
entry_id	integer	The ID of the garage
name	string	The name of the garage
address	string	The address of the garage
location	string	In which postcode area the garage is located
longitude	float	The longitude of the garage
latitude	float	The latitude of the garage

Example

import asyncio

from dusseldorf import ODPDusseldorf


async def main() -> None:
    """Show example on using the Dusseldorf API client."""
    async with ODPDusseldorf() as client:
        disabled_parkings = await client.disabled_parkings()
        park_and_rides = await client.park_and_rides()
        garages = await client.garages()

        print(disabled_parkings)
        print(park_and_rides)
        print(garages)


if __name__ == "__main__":
    asyncio.run(main())

Use cases

NIPKaart.nl

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.

Contributing

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! 😍

Setting up development environment

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

Installation

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages.

Pre-commit

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

Testing

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

License

MIT License

Copyright (c) 2022-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.