Skip to main content

Asynchronous Python client providing Urban Data information of Hamburg

Project description

Python - UDP Hamburg Client

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity Forks Stargazers Issues GitHub Last Commit

Code Quality Maintainability Code Coverage

Build Status Typing Status

Asynchronous Python client for the urban datasets of Hamburg (Germany).

About

A python package with which you can retrieve data from the Urban Data Platform of Hamburg 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 hamburg

Datasets

You can read the following datasets with this package:

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

  • limit (default: 10) - How many results you want to retrieve.
  • bulk (default: false) - If string is true, number of rows will be ignored and the entire result will be returned.
Click here to get more details

Disabled parking spaces

Variable Type Description
spot_id string The ID of the parking spot
street string The street name
limitation string Some locations have window times where the location is only specific for disabled parking, outside these times everyone is allowed to park there
number string The number of parking spots on this location
longitude float The longitude of the parking spot
latitude float The latitude of the parking spot

Park and Rides

Variable Type Description
spot_id string The ID of the park and ride
name string The name of the park and ride
park_type string The parking type of the park and ride
address string The address of the park and ride
construction_year string The year the park and ride was constructed
public_transport_line string The public transport line the park and ride is connected to
disabled_parking_spaces int The number of disabled parking spaces on the park and ride
tickets dict The type of tickets available for the park and ride
url string The URL of the park and ride where you can find more information
free_space int The number of free spaces on the park and ride
capacity int The capacity of the park and ride
availability_pct float The percentage of the park and ride that is available
longitude float The longitude of the park and ride
latitude float The latitude of the park and ride
updated_at datetime The date and time the park and ride was last updated

Garages

Extra parameters to filter the data:

  • available (default: None) - Allows you to filter based on available spaces, using operators such as <, <=, > and >=.
Variable Type Description
spot_id string The ID of the garage
name string The name of the pgarage
park_type string The parking type of the garage
disabled_parking_spaces int The number of disabled parking spaces in the garage
status string The status of the garage (frei, nahezu belegt, besetzt or keine Auslastungsdaten)
address string The address of the garage
price string The price list that is used for parking in a garage
data_origin string Where data originally comes from
free_space int The number of free spaces in the garage
capacity int The capacity of the garage
availability_pct float The percentage that is still available in the garage
longitude float The longitude of the garage
latitude float The latitude of the garage
updated_at datetime The date and time the garage was last updated

Example

import asyncio

from hamburg import UDPHamburg


async def main() -> None:
    """Show example on using the UDP Hamburg API client."""
    async with UDPHamburg() 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! :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) 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

hamburg-0.3.0.tar.gz (13.1 kB view hashes)

Uploaded source

Built Distribution

hamburg-0.3.0-py3-none-any.whl (9.8 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