<!-- Banner -->
<!-- PROJECT SHIELDS -->
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](LICENSE)
[![GitHub Activity][commits-shield]][commits-url]
[![PyPi Downloads][downloads-shield]][downloads-url]
[![GitHub Last Commit][last-commit-shield]][commits-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Code Quality][code-quality-shield]][code-quality]
[![Build Status][build-shield]][build-url]
[![Typing Status][typing-shield]][typing-url]
[![Maintainability][maintainability-shield]][maintainability-url]
[![Code Coverage][codecov-shield]][codecov-url]
Asynchronous Python client for the open datasets of Köln (Germany).
## About
A python package with which you can retrieve data from the Open Data Platform of Köln 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.
## Installation
```bash
pip install koeln
```
## Datasets
You can read the following datasets with this package:
- [Disabled parking spaces / Behindertenparkplätze][disabled_parkings] (441 locations)
<details>
<summary>Click here to get more details</summary>
### Disabled parking spaces
| Variable | Type | Description |
| :------- | :--- | :---------- |
| `entry_id` | integer | The ID for the parking location |
| `number` | integer | The number of the parking spaces on this location |
| `district` | string | The district name where the parking location is located |
| `district_nr` | integer | The district number where the parking location is located |
| `note` | string | A note about the parking location |
| `longitude` | float | The longitude of the parking location |
| `latitude` | float | The latitude of the parking location |
</details>
## Example
```python
import asyncio
from koeln import StadtKoeln
async def main() -> None:
"""Show example on using the API of Köln."""
async with StadtKoeln() as client:
disabled_parkings = await client.disabled_parkings()
print(disabled_parkings)
if __name__ == "__main__":
asyncio.run(main())
```
## Use cases
[NIPKaart.nl][nipkaart]
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](CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
This Python project is fully managed using the [Poetry][poetry] dependency
manager.
You need at least:
- Python 3.9+
- [Poetry][poetry-install]
Install all packages, including all development requirements:
```bash
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:
```bash
poetry shell
exit
```
Setup the pre-commit check, you must run this inside the virtual environment:
```bash
pre-commit install
```
*Now you're all set to get started!*
As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
```bash
poetry run pre-commit run --all-files
```
To run just the Python tests:
```bash
poetry run pytest
```
## License
MIT License
Copyright (c) 2022-2023 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.
[api]: https://offenedaten-koeln.de
[disabled_parkings]: https://offenedaten-koeln.de/dataset/behindertenparkpl%C3%A4tze-k%C3%B6ln
[nipkaart]: https://www.nipkaart.nl
<!-- MARKDOWN LINKS & IMAGES -->
[build-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/tests.yaml/badge.svg
[build-url]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/tests.yaml
[code-quality-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/codeql.yaml/badge.svg
[code-quality]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/codeql.yaml
[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-koeln.svg
[commits-url]: https://github.com/klaasnicolaas/python-koeln/commits/main
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-koeln/branch/main/graph/badge.svg?token=CRONIDYXGQ
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-koeln
[downloads-shield]: https://img.shields.io/pypi/dm/koeln
[downloads-url]: https://pypistats.org/packages/koeln
[issues-shield]: https://img.shields.io/github/issues/klaasnicolaas/python-koeln.svg
[issues-url]: https://github.com/klaasnicolaas/python-koeln/issues
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-koeln.svg
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-koeln.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
[maintainability-shield]: https://api.codeclimate.com/v1/badges/6c4ccfaa4a5a8cbc5ff8/maintainability
[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-koeln/maintainability
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[pypi]: https://pypi.org/project/koeln/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/koeln
[typing-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/typing.yaml/badge.svg
[typing-url]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/typing.yaml
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-koeln.svg
[releases]: https://github.com/klaasnicolaas/python-koeln/releases
[stars-shield]: https://img.shields.io/github/stars/klaasnicolaas/python-koeln.svg
[stars-url]: https://github.com/klaasnicolaas/python-koeln/stargazers
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com
Raw data
{
"_id": null,
"home_page": "https://github.com/klaasnicolaas/python-koeln",
"name": "koeln",
"maintainer": "Klaas Schoute",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "hello@student-techlife.com",
"keywords": "open,data,platform,K\u00f6ln,cologne,parking,api,async,client",
"author": "Klaas Schoute",
"author_email": "hello@student-techlife.com",
"download_url": "https://files.pythonhosted.org/packages/df/86/4b017868f7febd26caf715613b3f8f7a6c949d784306b27609f43766df78/koeln-0.3.1.tar.gz",
"platform": null,
"description": "<!-- Banner -->\n\n\n<!-- PROJECT SHIELDS -->\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[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\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 K\u00f6ln (Germany).\n\n## About\n\nA python package with which you can retrieve data from the Open Data Platform of K\u00f6ln 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 koeln\n```\n\n## Datasets\n\nYou can read the following datasets with this package:\n\n- [Disabled parking spaces / Behindertenparkpl\u00e4tze][disabled_parkings] (441 locations)\n\n<details>\n <summary>Click here to get more details</summary>\n\n### Disabled parking spaces\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `entry_id` | integer | The ID for the parking location |\n| `number` | integer | The number of the parking spaces on this location |\n| `district` | string | The district name where the parking location is located |\n| `district_nr` | integer | The district number where the parking location is located |\n| `note` | string | A note about the parking location |\n| `longitude` | float | The longitude of the parking location |\n| `latitude` | float | The latitude of the parking location |\n</details>\n\n## Example\n\n```python\nimport asyncio\n\nfrom koeln import StadtKoeln\n\n\nasync def main() -> None:\n \"\"\"Show example on using the API of K\u00f6ln.\"\"\"\n async with StadtKoeln() as client:\n disabled_parkings = await client.disabled_parkings()\n print(disabled_parkings)\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\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\nThis Python project is fully managed using the [Poetry][poetry] dependency\nmanager.\n\nYou need at least:\n\n- Python 3.9+\n- [Poetry][poetry-install]\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\nPoetry creates by default an virtual environment where it installs all\nnecessary pip packages, to enter or exit the venv run the following commands:\n\n```bash\npoetry shell\nexit\n```\n\nSetup the pre-commit check, you must run this inside the virtual environment:\n\n```bash\npre-commit install\n```\n\n*Now you're all set to get started!*\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2022-2023 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://offenedaten-koeln.de\n[disabled_parkings]: https://offenedaten-koeln.de/dataset/behindertenparkpl%C3%A4tze-k%C3%B6ln\n[nipkaart]: https://www.nipkaart.nl\n\n<!-- MARKDOWN LINKS & IMAGES -->\n[build-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-koeln.svg\n[commits-url]: https://github.com/klaasnicolaas/python-koeln/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-koeln/branch/main/graph/badge.svg?token=CRONIDYXGQ\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-koeln\n[downloads-shield]: https://img.shields.io/pypi/dm/koeln\n[downloads-url]: https://pypistats.org/packages/koeln\n[issues-shield]: https://img.shields.io/github/issues/klaasnicolaas/python-koeln.svg\n[issues-url]: https://github.com/klaasnicolaas/python-koeln/issues\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-koeln.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-koeln.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/6c4ccfaa4a5a8cbc5ff8/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-koeln/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/koeln/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/koeln\n[typing-shield]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-koeln/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-koeln.svg\n[releases]: https://github.com/klaasnicolaas/python-koeln/releases\n[stars-shield]: https://img.shields.io/github/stars/klaasnicolaas/python-koeln.svg\n[stars-url]: https://github.com/klaasnicolaas/python-koeln/stargazers\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous Python client providing Open Data information of K\u00f6ln",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/klaasnicolaas/python-koeln/issues",
"Changelog": "https://github.com/klaasnicolaas/python-koeln/releases",
"Documentation": "https://github.com/klaasnicolaas/python-koeln",
"Homepage": "https://github.com/klaasnicolaas/python-koeln",
"Repository": "https://github.com/klaasnicolaas/python-koeln"
},
"split_keywords": [
"open",
"data",
"platform",
"k\u00f6ln",
"cologne",
"parking",
"api",
"async",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65f2892d5ccea5c6dad9debadc20c10db1c63eb7815cf533ce09577668817154",
"md5": "194438b7b33f67683c25259238ce9e85",
"sha256": "51051587c751a0119f2fe91a3e762a99c075accf4df50e420142880f4288a797"
},
"downloads": -1,
"filename": "koeln-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "194438b7b33f67683c25259238ce9e85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 7886,
"upload_time": "2023-07-05T10:30:45",
"upload_time_iso_8601": "2023-07-05T10:30:45.808531Z",
"url": "https://files.pythonhosted.org/packages/65/f2/892d5ccea5c6dad9debadc20c10db1c63eb7815cf533ce09577668817154/koeln-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df864b017868f7febd26caf715613b3f8f7a6c949d784306b27609f43766df78",
"md5": "804ae716915fbcd6f65196384d83fcf5",
"sha256": "35362ff27c7f13526c2e75e24e747afac73885d851a5d1a4c291bc705629bc2f"
},
"downloads": -1,
"filename": "koeln-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "804ae716915fbcd6f65196384d83fcf5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 9525,
"upload_time": "2023-07-05T10:30:47",
"upload_time_iso_8601": "2023-07-05T10:30:47.089486Z",
"url": "https://files.pythonhosted.org/packages/df/86/4b017868f7febd26caf715613b3f8f7a6c949d784306b27609f43766df78/koeln-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 10:30:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klaasnicolaas",
"github_project": "python-koeln",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "koeln"
}
JSON
