README.md

Asynchronous Python client for the open datasets of Liège (Belgium).

About

A python package with which you can retrieve data from the Open Data Platform of Liège 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 liege

Datasets

You can read the following datasets with this package:

• Disabled parking spaces / Stationnement PMR (1062 locations)
• Garages / Les parkings voitures hors voirie (32 locations)

Click here to get more details

Disabled parkings

Parameters:

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

Variable	Type	Description
spot_id	int	The ID of the parking spot
number	int	How many parking spots there are on this location
address	str	The address of the parking spot
municipality	str	The municipality of the parking spot
city	str	The city of the parking spot
status	str	The status of the parking spot
longitude	float	The longitude of the parking spot
latitude	float	The latitude of the parking spot
created_at	datetime	When the parking spot was added to the dataset
updated_at	datetime	The last time the data was updated

Garages

Parameters:

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

Variable	Type	Description
name	string	The name of the garage
capacity	int	The capacity of the garage
charging_stations	int	The number of charging stations
address	string	The address of the garage
municipality	string	The municipality of the garage
city	string	The city of the garage
provider	string	The provider of the garage
schedule	string	The schedule of the garage
longitude	float	The longitude of the garage
latitude	float	The latitude of the garage
created_at	datetime	When the garage was added to the dataset
updated_at	datetime	The last time the data was updated

Example

import asyncio

from liege import ODPLiege


async def main() -> None:
    """Show example on using the Open Data API client."""
    async with ODPLiege() as client:
        garages = await client.garages(limit=10)
        disabled_parkings = await client.disabled_parkings(limit=10)
        print(garages)
        print(disabled_parkings)


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.