Skip to main content

Asynchronous Python client providing Open Data information of Eindhoven

Project description

alt Banner of the eindhoven package

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity PyPi Downloads GitHub Last Commit Stargazers Issues

Code Quality Maintainability Code Coverage

Build Status Typing Status

Asynchronous Python client for the open datasets of Eindhoven (The Netherlands).

About

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.

Installation

pip install eindhoven

Datasets

You can read the following datasets with this package:

Click here to get more details

Parkings spots

You can use the following parameters in your request:

  • limit (default: 10) - How many results you want to retrieve.
  • parking_type (default: 1) - See the list below to find the corresponding number.
parking_type number
Parkeerplaats 1
Parkeerplaats Vergunning 2
Parkeerplaats Gehandicapten 3
Parkeerplaats Afgekruist 4
Parkeerplaats laden/lossen 5
Parkeerplaats Electrisch opladen 6

You get the following output data back with this python package:

Variable Type Description
spot_id string The id of the parking spot
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
longitude float The longitude of the parking spot
latitude float The latitude of the parking spot
updated_at datetime When this parking spot was updated in the dataset

Example

import asyncio

from eindhoven import ODPEindhoven


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=4)
        print(locations)


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! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager.

You need at least:

Install all packages, including all development requirements:

poetry install

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:

pre-commit install

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

License

MIT License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eindhoven-3.1.0.tar.gz (9.2 kB view hashes)

Uploaded source

Built Distribution

eindhoven-3.1.0-py3-none-any.whl (8.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page