{"id":16237157,"url":"https://github.com/klaasnicolaas/python-odp-gent","last_synced_at":"2025-03-19T15:31:10.414Z","repository":{"id":45767040,"uuid":"513731195","full_name":"klaasnicolaas/python-odp-gent","owner":"klaasnicolaas","description":"🗃️ Asynchronous Python client for the open datasets of Gent (🇧🇪 - Belgium)","archived":false,"fork":false,"pushed_at":"2024-10-29T23:25:12.000Z","size":1975,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-30T01:51:42.008Z","etag":null,"topics":["api","async","client","gent","hacktoberfest","nipkaart","opendata","python"],"latest_commit_sha":null,"homepage":"https://data.stad.gent","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-14T02:17:01.000Z","updated_at":"2024-10-29T23:25:15.000Z","dependencies_parsed_at":"2024-01-01T00:30:26.570Z","dependency_job_id":"7dcb09df-a6eb-499f-b170-48c7c518ef50","html_url":"https://github.com/klaasnicolaas/python-odp-gent","commit_stats":{"total_commits":361,"total_committers":3,"mean_commits":"120.33333333333333","dds":0.5096952908587258,"last_synced_commit":"7011c573b86127ee13577552d4b1b9f13cab5f16"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-odp-gent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-odp-gent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-odp-gent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-odp-gent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-odp-gent/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244003346,"owners_count":20382175,"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","gent","hacktoberfest","nipkaart","opendata","python"],"created_at":"2024-10-10T13:34:41.593Z","updated_at":"2025-03-19T15:31:10.408Z","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 odp gent package](https://raw.githubusercontent.com/klaasnicolaas/python-odp-gent/main/assets/header_odp_gent-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 open datasets of Gent (Belgium).\n\n## About\n\nA python package with which you can retrieve data from the Open Data Platform of Gent 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 odp-gent\n```\n\n## Datasets\n\nYou can read the following datasets with this package:\n\n- [Parking garages occupancy][garages] (12 locations)\n- [Park and Ride occupancy][parkandride] (5 locations)\n- [BlueBike rental locations][bluebike] (6 locations)\n- [Partago vehicle locations][partago] (116 locations)\n\nFind here [more information](examples) about the different variables and parameters per dataset with this python package.\n\n## Example\n\n```python\nimport asyncio\n\nfrom odp_gent import ODPGent\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on using the Open Data API client.\"\"\"\n    async with ODPGent() as client:\n        garages = await client.garages(limit=12)\n        park_and_rides = await client.park_and_rides(limit=5, gentse_feesten=\"True\")\n        print(garages)\n        print(park_and_rides)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\nYou can find more code examples in the [examples](examples) folder.\n\n## Use cases\n\n[NIPKaart.nl][nipkaart]\n\nA website that provides insight into where disabled parking spaces are, based\non data from users and municipalities. Operates mainly in the Netherlands, but\nalso 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://data.stad.gent/explore\n[nipkaart]: https://www.nipkaart.nl\n\n[garages]: https://data.stad.gent/explore/dataset/bezetting-parkeergarages-real-time/information\n[parkandride]: https://data.stad.gent/explore/dataset/real-time-bezetting-pr-gent/information\n[bluebike]: https://data.stad.gent/explore/?disjunctive.keyword\u0026disjunctive.theme\u0026sort=modified\u0026q=bluebike\n[partago]: https://data.stad.gent/explore/dataset/real-time-locaties-deelwagen-partago/information\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-odp-gent.svg\n[commits-url]: https://github.com/klaasnicolaas/python-odp-gent/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-odp-gent/branch/main/graph/badge.svg?token=5JNbz4akUL\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-odp-gent\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-odp-gent\n[downloads-shield]: https://img.shields.io/pypi/dm/odp-gent\n[downloads-url]: https://pypistats.org/packages/odp-gent\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-odp-gent.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-odp-gent.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/ceb27fb15cf0e485dc23/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-odp-gent/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/odp-gent/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/odp-gent\n[typing-shield]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-odp-gent.svg\n[releases]: https://github.com/klaasnicolaas/python-odp-gent/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-odp-gent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-odp-gent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-odp-gent/lists"}