{"id":16237158,"url":"https://github.com/klaasnicolaas/python-hamburg","last_synced_at":"2025-07-13T04:38:30.947Z","repository":{"id":45400205,"uuid":"513139288","full_name":"klaasnicolaas/python-hamburg","owner":"klaasnicolaas","description":"🗃️ Asynchronous Python client for the urban datasets of Hamburg (🇩🇪 - Germany)","archived":false,"fork":false,"pushed_at":"2024-05-10T02:27:54.000Z","size":1648,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-11T22:45:31.951Z","etag":null,"topics":["api","async","client","hacktoberfest","hamburg","nipkaart","opendata","parking","python"],"latest_commit_sha":null,"homepage":"https://api.hamburg.de/datasets/v1/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaasnicolaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2022-07-12T12:47:13.000Z","updated_at":"2024-05-12T23:20:28.873Z","dependencies_parsed_at":"2023-12-25T01:39:41.333Z","dependency_job_id":"8664c41b-ed5d-4efe-becd-6af921683d9a","html_url":"https://github.com/klaasnicolaas/python-hamburg","commit_stats":{"total_commits":400,"total_committers":3,"mean_commits":"133.33333333333334","dds":0.5449999999999999,"last_synced_commit":"d72d2a671364d99710f2e8be42a975a5a178f429"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-hamburg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-hamburg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-hamburg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-hamburg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-hamburg/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240593170,"owners_count":19825930,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","async","client","hacktoberfest","hamburg","nipkaart","opendata","parking","python"],"created_at":"2024-10-10T13:34:41.671Z","updated_at":"2025-02-25T02:45:05.077Z","avatar_url":"https://github.com/klaasnicolaas.png","language":"Python","funding_links":["https://github.com/sponsors/klaasnicolaas","https://ko-fi.com/klaasnicolaas"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n![alt Banner of the Hamburg package](https://raw.githubusercontent.com/klaasnicolaas/python-hamburg/main/assets/header_hamburg-min.png)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Code Quality][code-quality-shield]][code-quality]\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\nAsynchronous Python client for the urban datasets of Hamburg (Germany).\n\n## About\n\nA python package with which you can retrieve data from the Urban Data Platform of Hamburg via [their API][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.\n\n## Installation\n\n```bash\npip install hamburg\n```\n\n## Datasets\n\nYou can read the following datasets with this package:\n\n- [Disabled parking spaces / Behindertenstellplätze][disabled_parking] (901)\n- [Park and rides occupancy / Park + Ride Anlagen][park_and_ride] (33)\n- [Garages occupancy / Parkhäuser][garages] (45 live data / 124 total)\n\nThere are a number of parameters you can set to retrieve the data:\n\n- **limit** (default: 10) - How many results you want to retrieve.\n\n\u003cdetails\u003e\n    \u003csummary\u003eClick here to get more details\u003c/summary\u003e\n\n### Disabled parking spaces\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `spot_id` | string | The ID of the parking spot |\n| `street` | string | The street name |\n| `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 |\n| `number` | string | The number of parking spots on this location |\n| `longitude` | float | The longitude of the parking spot |\n| `latitude` | float | The latitude of the parking spot |\n\n### Park and Rides\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `spot_id` | string | The ID of the park and ride |\n| `name` | string | The name of the park and ride |\n| `park_type` | string | The parking type of the park and ride |\n| `address` | string | The address of the park and ride |\n| `construction_year` | string | The year the park and ride was constructed |\n| `public_transport_line` | string | The public transport line the park and ride is connected to |\n| `disabled_parking_spaces` | int | The number of disabled parking spaces on the park and ride |\n| `tickets` | dict | The type of tickets available for the park and ride |\n| `url` | string | The URL of the park and ride where you can find more information |\n| `free_space` | int | The number of free spaces on the park and ride |\n| `capacity` | int | The capacity of the park and ride |\n| `availability_pct` | float | The percentage of the park and ride that is available |\n| `longitude` | float | The longitude of the park and ride |\n| `latitude` | float | The latitude of the park and ride |\n| `updated_at` | datetime | The date and time the park and ride was last updated |\n\n### Garages\n\nExtra parameters to filter the data:\n\n- **set_filter** (default: None) - Allows you to filter based on filter expressions, see [here](https://api.hamburg.de/datasets/v1/parkhaeuser/api?f=html#/Access%20data/verkehr_parkhaeuser.getItems) for more information.\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `spot_id` | string | The ID of the garage |\n| `name` | string | The name of the pgarage |\n| `park_type` | string | The parking type of the garage |\n| `disabled_parking_spaces` | int | The number of disabled parking spaces in the garage |\n| `status` | string | The status of the garage (**frei**, **nahezu belegt**, **besetzt** or **keine Auslastungsdaten**) |\n| `address` | string | The address of the garage |\n| `price` | string | The price list that is used for parking in a garage |\n| `data_origin` | string | Where data originally comes from |\n| `free_space` | int | The number of free spaces in the garage |\n| `capacity` | int | The capacity of the garage |\n| `availability_pct` | float | The percentage that is still available in the garage |\n| `longitude` | float | The longitude of the garage |\n| `latitude` | float | The latitude of the garage |\n| `updated_at` | datetime | The date and time the garage was last updated |\n\n\u003c/details\u003e\n\n## Example\n\n```python\nimport asyncio\n\nfrom hamburg import UDPHamburg\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on using the UDP Hamburg API client.\"\"\"\n    async with UDPHamburg() as client:\n        disabled_parkings = await client.disabled_parkings()\n        park_and_rides = await client.park_and_rides()\n        garages = await client.garages()\n        print(disabled_parkings)\n        print(park_and_rides)\n        print(garages)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## Use cases\n\n[NIPKaart.nl][nipkaart]\n\nA 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.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\n### Installation\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\n_Poetry creates by default an virtual environment where it installs all\nnecessary pip packages_.\n\n### Pre-commit\n\nThis repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. To setup the pre-commit check, run:\n\n```bash\npoetry run pre-commit install\n```\n\nAnd to run all checks and tests manually, use the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\n### Testing\n\nIt uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2022-2025 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[api]: https://api.hamburg.de/datasets/v1/\n[nipkaart]: https://www.nipkaart.nl\n\n[disabled_parking]: https://api.hamburg.de/datasets/v1/behindertenstellplaetze\n[park_and_ride]: https://api.hamburg.de/datasets/v1/p_und_r\n[garages]: https://api.hamburg.de/datasets/v1/parkhaeuser\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-hamburg.svg\n[commits-url]: https://github.com/klaasnicolaas/python-hamburg/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-hamburg/branch/main/graph/badge.svg?token=4Y4YAYHR2D\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-hamburg\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-hamburg\n[downloads-shield]: https://img.shields.io/pypi/dm/hamburg\n[downloads-url]: https://pypistats.org/packages/hamburg\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-hamburg.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-hamburg.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/5041849456b7348f3bc7/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-hamburg/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[pypi]: https://pypi.org/project/hamburg/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/hamburg\n[typing-shield]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-hamburg/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-hamburg.svg\n[releases]: https://github.com/klaasnicolaas/python-hamburg/releases\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-hamburg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-hamburg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-hamburg/lists"}