koeln 0.3.1
Asynchronous Python client providing Open Data information of Köln
License: MIT
Requires Python: >=3.9,<4.0
Keywords: open,data,platform,Köln,cologne,parking,api,async,client

<!-- Banner -->
![alt Banner of the odp köln package](https://raw.githubusercontent.com/klaasnicolaas/python-koeln/main/assets/header_koeln-min.png)

<!-- 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