Asynchronous Python client providing Open Data information of Köln
Python - ODP Köln Client
Asynchronous Python client for the open datasets of Köln (Germany).
A python package with which you can retrieve data from the Open Data Platform of Köln 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 koeln
You can read the following datasets with this package:
- Disabled parking spaces / Behindertenparkplätze (425 locations)
Click here to get more details
Disabled parking spaces
||integer||The ID for the parking location|
||integer||The number of the parking spaces on this location|
||string||The district name where the parking location is located|
||integer||The district number where the parking location is located|
||string||A note about the parking location|
||float||The longitude of the parking location|
||float||The latitude of the parking location|
import asyncio from koeln import StadtKoeln async def main() -> None: """Show example on using the API of Köln.""" async with StadtKoeln() as client: disabled_parkings = await client.disabled_parkings() print(disabled_parkings) 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! :heart_eyes:
Setting up development environment
This Python project is fully managed using the Poetry dependency manager.
You need at least:
- Python 3.9+
Install all packages, including all development requirements:
Poetry creates by default an virtual environment where it installs all necessary pip packages, to enter or exit the venv run the following commands:
poetry shell exit
Setup the pre-commit check, you must run this inside the virtual environment:
Now you're all set to get started!
As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:
poetry run pre-commit run --all-files
To run just the Python tests:
poetry run pytest
Copyright (c) 2022 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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.