Metadata-Version: 2.4
Name: odp-gent
Version: 1.0.0
Summary: Asynchronous Python client providing Open Data information of Gent
Keywords: open,data,platform,parking,gent,api,async,client
Author: Klaas Schoute
Author-email: Klaas Schoute <hello@student-techlife.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: aiohttp>=3.0.0
Requires-Dist: yarl>=1.6.0
Maintainer: Klaas Schoute
Maintainer-email: Klaas Schoute <hello@student-techlife.com>
Requires-Python: >=3.12
Project-URL: Bug Tracker, https://github.com/klaasnicolaas/python-odp-gent/issues
Project-URL: Changelog, https://github.com/klaasnicolaas/python-odp-gent/releases
Project-URL: homepage, https://github.com/klaasnicolaas/python-odp-gent
Project-URL: repository, https://github.com/klaasnicolaas/python-odp-gent
Project-URL: documentation, https://github.com/klaasnicolaas/python-odp-gent
Description-Content-Type: text/markdown

<!-- Banner -->
![alt Banner of the odp gent package](https://raw.githubusercontent.com/klaasnicolaas/python-odp-gent/main/assets/header_odp_gent-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]
[![Open in Dev Containers][devcontainer-shield]][devcontainer]

[![Build Status][build-shield]][build-url]
[![Typing Status][typing-shield]][typing-url]
[![Code Coverage][codecov-shield]][codecov-url]
[![OpenSSF Scorecard][scorecard-shield]][scorecard-url]

Asynchronous Python client for the open datasets of Gent (Belgium).

## About

A 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.

## Installation

```bash
pip install odp-gent
```

## Datasets

You can read the following datasets with this package:

- [Parking garages occupancy][garages] (12 locations)
- [Park and Ride occupancy][parkandride] (5 locations)
- [BlueBike rental locations][bluebike] (6 locations)
- [Partago vehicle locations][partago] (116 locations)

Find here [more information](examples) about the different variables and parameters per dataset with this python package.

## Example

```python
import asyncio

from odp_gent import ODPGent


async def main() -> None:
    """Show example on using the Open Data API client."""
    async with ODPGent() as client:
        garages = await client.garages(limit=12)
        park_and_rides = await client.park_and_rides(limit=5, gentse_feesten="True")
        print(garages)
        print(park_and_rides)


if __name__ == "__main__":
    asyncio.run(main())
```
You can find more code examples in the [examples](examples) folder.

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

The simplest way to begin is by utilizing the [Dev Container][devcontainer]
feature 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.

[![Open in Dev Containers][devcontainer-shield]][devcontainer]

This Python project relies on [uv][uv] as its dependency manager,
providing comprehensive management and control over project dependencies.

You need at least:

- Python 3.12+
- [uv][uv-install]

### Installation

Install all packages, including all development requirements:

```bash
uv sync --locked
```

_uv creates a project virtual environment in `.venv` and installs the locked dependencies._

### Prek

This repository uses the [prek][prek] framework, all changes
are linted and tested with each commit. To setup the prek check, run:

```bash
uv run prek install
```

And to run all checks and tests manually, use the following command:

```bash
uv run prek run --all-files
```

### Testing

It uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:

```bash
uv run pytest
```

To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:

```bash
uv run pytest --snapshot-update
```

### Source timestamps

Dates use Python's standard-library `datetime`; this package does not require `pytz`. BlueBike preserves the offset in `last_seen` instead of overwriting it with a Brussels timezone (which previously introduced a historical 18-minute offset). Partago preserves the UTC `Z` suffix and fractional seconds. Both reject timestamps without a timezone.

### Complete parking feed

`await client.parking_collection()` retrieves every page of `bezetting-parkeergarages-real-time` and returns `Collection(records, total_count, pages_fetched, complete)`. Its `ParkingFacility` records use the original `fields.id` as `facility_id`; the existing limited `garages()` API keeps its portal `recordid` behavior for compatibility. Pagination rejects missing/duplicate facility IDs, changing totals, short pages and safety-ceiling truncation (`max_records=10000`).

Measurements keep the source `lastupdate` timezone and general counts. Missing or invalid/undated times stay `None`, never the retrieval time; unknown counts/flags stay `None`, measured zero stays zero. The feed includes different parking types; consumers choose their own selection. The former separate P+R dataset returned 404 when checked on 2026-10-13; this method retrieves the current unified live feed instead.

## License

MIT License

Copyright (c) 2022-2026 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://data.stad.gent/explore
[nipkaart]: https://www.nipkaart.nl

[garages]: https://data.stad.gent/explore/dataset/bezetting-parkeergarages-real-time/information
[parkandride]: https://data.stad.gent/explore/dataset/real-time-bezetting-pr-gent/information
[bluebike]: https://data.stad.gent/explore/?disjunctive.keyword&disjunctive.theme&sort=modified&q=bluebike
[partago]: https://data.stad.gent/explore/dataset/real-time-locaties-deelwagen-partago/information

<!-- MARKDOWN LINKS & IMAGES -->
[build-shield]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/tests.yaml/badge.svg
[build-url]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/tests.yaml
[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-odp-gent.svg
[commits-url]: https://github.com/klaasnicolaas/python-odp-gent/commits/main
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-odp-gent/branch/main/graph/badge.svg?token=5JNbz4akUL
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-odp-gent
[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-odp-gent
[downloads-shield]: https://img.shields.io/pypi/dm/odp-gent
[downloads-url]: https://pypistats.org/packages/odp-gent
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-odp-gent.svg
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-odp-gent.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[pypi]: https://pypi.org/project/odp-gent/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/odp-gent
[typing-shield]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/typing.yaml/badge.svg
[typing-url]: https://github.com/klaasnicolaas/python-odp-gent/actions/workflows/typing.yaml
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-odp-gent.svg
[releases]: https://github.com/klaasnicolaas/python-odp-gent/releases

[uv-install]: https://docs.astral.sh/uv/getting-started/installation/
[uv]: https://docs.astral.sh/uv/
[prek]: https://github.com/j178/prek
[scorecard-shield]: https://api.scorecard.dev/projects/github.com/klaasnicolaas/python-odp-gent/badge
[scorecard-url]: https://scorecard.dev/viewer/?uri=github.com/klaasnicolaas/python-odp-gent
