Package: hamburg
Asynchronous Python client for the urban datasets of Hamburg (Germany).AboutA python package with which you can retrieve data from the Urban Data Platform of Hamburg viatheir 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.InstallationpipinstallhamburgDatasetsYou can read the following datasets with this package:Disabled parking spaces / Behindertenstellplätze(901)Park and rides occupancy / Park + Ride Anlagen(33)Garages occupancy / Parkhäuser(45 live data / 124 total)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 detailsDisabled parking spacesVariableTypeDescriptionspot_idstringThe ID of the parking spotstreetstringThe street namelimitationstringSome locations have window times where the location is only specific for disabled parking, outside these times everyone is allowed to park therenumberstringThe number of parking spots on this locationlongitudefloatThe longitude of the parking spotlatitudefloatThe latitude of the parking spotPark and RidesVariableTypeDescriptionspot_idstringThe ID of the park and ridenamestringThe name of the park and ridepark_typestringThe parking type of the park and rideaddressstringThe address of the park and rideconstruction_yearstringThe year the park and ride was constructedpublic_transport_linestringThe public transport line the park and ride is connected todisabled_parking_spacesintThe number of disabled parking spaces on the park and rideticketsdictThe type of tickets available for the park and rideurlstringThe URL of the park and ride where you can find more informationfree_spaceintThe number of free spaces on the park and ridecapacityintThe capacity of the park and rideavailability_pctfloatThe percentage of the park and ride that is availablelongitudefloatThe longitude of the park and ridelatitudefloatThe latitude of the park and rideupdated_atdatetimeThe date and time the park and ride was last updatedGaragesExtra parameters to filter the data:available(default: None) - Allows you to filter based on available spaces, using operators such as<,<=,>and>=.VariableTypeDescriptionspot_idstringThe ID of the garagenamestringThe name of the pgaragepark_typestringThe parking type of the garagedisabled_parking_spacesintThe number of disabled parking spaces in the garagestatusstringThe status of the garage (frei,nahezu belegt,besetztorkeine Auslastungsdaten)addressstringThe address of the garagepricestringThe price list that is used for parking in a garagedata_originstringWhere data originally comes fromfree_spaceintThe number of free spaces in the garagecapacityintThe capacity of the garageavailability_pctfloatThe percentage that is still available in the garagelongitudefloatThe longitude of the garagelatitudefloatThe latitude of the garageupdated_atdatetimeThe date and time the garage was last updatedExampleimportasynciofromhamburgimportUDPHamburgasyncdefmain()->None:"""Show example on using the UDP Hamburg API client."""asyncwithUDPHamburg()asclient:disabled_parkings=awaitclient.disabled_parkings()park_and_rides=awaitclient.park_and_rides()garages=awaitclient.garages()print(disabled_parkings)print(park_and_rides)print(garages)if__name__=="__main__":asyncio.run(main())Use casesNIPKaart.nlA 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.ContributingThis 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 ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up development environmentThe simplest way to begin is by utilizing theDev Containerfeature 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 onPoetryas its dependency manager,
providing comprehensive management and control over project dependencies.You need at least:Python 3.11+PoetryInstall all packages, including all development requirements:poetryinstallPoetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:poetryshellexitSetup the pre-commit check, you must run this inside the virtual environment:pre-commitinstallNow you're all set to get started!As this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestLicenseMIT LicenseCopyright (c) 2022-2023 Klaas SchoutePermission 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.