<!-- Header -->
<!-- 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]
[![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 Amsterdam (The Netherlands).
## About
A python package with which you can retrieve data from the Open Data Platform of Amsterdam 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-amsterdam
```
## Datasets
You can read the following datasets with this package:
- [Parking garages occupancy / Garages parkeerbezetting][garages] (53 garages)
- [Parking locations / Parkeervakken][parking]
<details>
<summary>Click here to get more details</summary>
### Parking garages
Read the occupancy of a garage in Amsterdam (The Netherlands), both for day visitors (short-term parking) and season ticket holders (long-term parking). The dataset gives garages for 🚲 bicycles (we ❤️ bikes) and for 🚗 cars
**NOTE**: Not all garages have data for long-term parking.
You can use the following parameters in your request:
- **vehicle** - Filter based on the type of vehicle that can park in the garage (`car`, `bicycle` or `touringcar`).
- **category** - Filter based on the category of the garage (`garage` or `park_and_ride`).
| Variable | Type | Description |
| :------- | :--- | :---------- |
| `garage_id` | string | The id of the garage |
| `garage_name` | string | The name of the garage |
| `vehicle` | string | The type of vehicle that can park in the garage |
| `category` | string | The category of the garage (`garage` or `park_and_ride`) |
| `state` | string | The state of the garage (`ok` or `problem`) |
| `free_space_short` | integer | The number of free spaces for day visitors |
| `free_space_long` | integer (or None) | The number of free spaces for season ticket holders |
| `short_capacity` | integer | The total capacity of the garage for day visitors |
| `long_capacity` | integer (or None) | The total capacity of the garage for season ticket holders |
| `availability_pct` | float | The percentage of free parking spaces |
| `longitude` | float | The longitude of the garage |
| `latitude` | float | The latitude of the garage |
| `updated_at` | datetime | The last time the data was updated |
### Parking locations
You can use the following parameters in your request:
- **limit** (default: 10) - How many results you want to retrieve.
- **parking_type** (default: "") - Filter based on the `eType` from the geojson data.
| Variable | Type | Description |
| :------- | :--- | :---------- |
| `spot_id` | string | The id of the location |
| `spot_type` | string (or None) | The type of the location (e.g. **E6a**) |
| `spot_description` | string (or None) | The description of the location type |
| `street` | string (or None) | The street name of the location |
| `number` | integer (or None) | How many parking spots there are on this location |
| `orientation` | string (or None) | The parking orientation of the location (**visgraag**, **langs** or **file**) |
| `coordinates` | list[float] | The coordinates of the location |
</details>
## Usage
```python
import asyncio
from odp_amsterdam import ODPAmsterdam
async def main():
"""Show example on using the ODP Amsterdam API client."""
async with ODPAmsterdam() as client:
# Parking locations
locations: list[ParkingSpot] = await client.location(
limit=5, parking_type="E6a"
)
# Garages
all_garages: list[Garage] = await client.all_garages()
garage: Garage = await client.garage(garage_id="ID_OF_GARAGE")
print(locations)
print(all_garages)
print(garage)
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
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 [Poetry][poetry] as its dependency manager,
providing comprehensive management and control over project dependencies.
You need at least:
- Python 3.11+
- [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
```
To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:
```bash
poetry run pytest --snapshot-update
```
## License
MIT License
Copyright (c) 2020-2024 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://api.data.amsterdam.nl
[nipkaart]: https://www.nipkaart.nl
[garages]: https://data.amsterdam.nl/datasets/9ORkef6T-aU29g/actuele-beschikbaarheid-parkeergarages/
[parking]: https://api.data.amsterdam.nl/v1/docs/datasets/parkeervakken.html
<!-- MARKDOWN LINKS & IMAGES -->
[build-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/tests.yaml/badge.svg
[build-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/tests.yaml
[code-quality-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/codeql.yaml/badge.svg
[code-quality]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/codeql.yaml
[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-odp-amsterdam.svg
[commits-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/commits/main
[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-odp-amsterdam/branch/main/graph/badge.svg?token=F6CE1S25NV
[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-odp-amsterdam
[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-amsterdam
[downloads-shield]: https://img.shields.io/pypi/dm/odp-amsterdam
[downloads-url]: https://pypistats.org/packages/odp-amsterdam
[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-odp-amsterdam.svg
[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-odp-amsterdam.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[maintainability-shield]: https://api.codeclimate.com/v1/badges/44c53d62dff1d3013e42/maintainability
[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-odp-amsterdam/maintainability
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[pypi]: https://pypi.org/project/odp-amsterdam/
[python-versions-shield]: https://img.shields.io/pypi/pyversions/odp-amsterdam
[typing-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/typing.yaml/badge.svg
[typing-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/typing.yaml
[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-odp-amsterdam.svg
[releases]: https://github.com/klaasnicolaas/python-odp-amsterdam/releases
[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-odp-amsterdam",
"name": "odp-amsterdam",
"maintainer": "Klaas Schoute",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "hello@student-techlife.com",
"keywords": "garages, amsterdam, car, occupancy, async, client",
"author": "Klaas Schoute",
"author_email": "hello@student-techlife.com",
"download_url": "https://files.pythonhosted.org/packages/91/76/37adb91b4a768731602d81c1baa097627cac46bac417918b8700a72faa7e/odp_amsterdam-6.0.2.tar.gz",
"platform": null,
"description": "<!-- Header -->\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[![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 Amsterdam (The Netherlands).\n\n## About\n\nA python package with which you can retrieve data from the Open Data Platform of Amsterdam 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-amsterdam\n```\n\n## Datasets\n\nYou can read the following datasets with this package:\n\n- [Parking garages occupancy / Garages parkeerbezetting][garages] (53 garages)\n- [Parking locations / Parkeervakken][parking]\n\n<details>\n <summary>Click here to get more details</summary>\n\n### Parking garages\n\nRead the occupancy of a garage in Amsterdam (The Netherlands), both for day visitors (short-term parking) and season ticket holders (long-term parking). The dataset gives garages for \ud83d\udeb2 bicycles (we \u2764\ufe0f bikes) and for \ud83d\ude97 cars\n\n**NOTE**: Not all garages have data for long-term parking.\n\nYou can use the following parameters in your request:\n\n- **vehicle** - Filter based on the type of vehicle that can park in the garage (`car`, `bicycle` or `touringcar`).\n- **category** - Filter based on the category of the garage (`garage` or `park_and_ride`).\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `garage_id` | string | The id of the garage |\n| `garage_name` | string | The name of the garage |\n| `vehicle` | string | The type of vehicle that can park in the garage |\n| `category` | string | The category of the garage (`garage` or `park_and_ride`) |\n| `state` | string | The state of the garage (`ok` or `problem`) |\n| `free_space_short` | integer | The number of free spaces for day visitors |\n| `free_space_long` | integer (or None) | The number of free spaces for season ticket holders |\n| `short_capacity` | integer | The total capacity of the garage for day visitors |\n| `long_capacity` | integer (or None) | The total capacity of the garage for season ticket holders |\n| `availability_pct` | float | The percentage of free parking spaces |\n| `longitude` | float | The longitude of the garage |\n| `latitude` | float | The latitude of the garage |\n| `updated_at` | datetime | The last time the data was updated |\n\n### Parking locations\n\nYou can use the following parameters in your request:\n\n- **limit** (default: 10) - How many results you want to retrieve.\n- **parking_type** (default: \"\") - Filter based on the `eType` from the geojson data.\n\n| Variable | Type | Description |\n| :------- | :--- | :---------- |\n| `spot_id` | string | The id of the location |\n| `spot_type` | string (or None) | The type of the location (e.g. **E6a**) |\n| `spot_description` | string (or None) | The description of the location type |\n| `street` | string (or None) | The street name of the location |\n| `number` | integer (or None) | How many parking spots there are on this location |\n| `orientation` | string (or None) | The parking orientation of the location (**visgraag**, **langs** or **file**) |\n| `coordinates` | list[float] | The coordinates of the location |\n</details>\n\n## Usage\n\n```python\nimport asyncio\n\nfrom odp_amsterdam import ODPAmsterdam\n\n\nasync def main():\n \"\"\"Show example on using the ODP Amsterdam API client.\"\"\"\n async with ODPAmsterdam() as client:\n # Parking locations\n locations: list[ParkingSpot] = await client.location(\n limit=5, parking_type=\"E6a\"\n )\n\n # Garages\n all_garages: list[Garage] = await client.all_garages()\n garage: Garage = await client.garage(garage_id=\"ID_OF_GARAGE\")\n\n print(locations)\n print(all_garages)\n print(garage)\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\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\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) 2020-2024 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.data.amsterdam.nl\n[nipkaart]: https://www.nipkaart.nl\n[garages]: https://data.amsterdam.nl/datasets/9ORkef6T-aU29g/actuele-beschikbaarheid-parkeergarages/\n[parking]: https://api.data.amsterdam.nl/v1/docs/datasets/parkeervakken.html\n\n<!-- MARKDOWN LINKS & IMAGES -->\n[build-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-odp-amsterdam.svg\n[commits-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-odp-amsterdam/branch/main/graph/badge.svg?token=F6CE1S25NV\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-odp-amsterdam\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-odp-amsterdam\n[downloads-shield]: https://img.shields.io/pypi/dm/odp-amsterdam\n[downloads-url]: https://pypistats.org/packages/odp-amsterdam\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-odp-amsterdam.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-odp-amsterdam.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/44c53d62dff1d3013e42/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-odp-amsterdam/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/odp-amsterdam/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/odp-amsterdam\n[typing-shield]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-odp-amsterdam/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-odp-amsterdam.svg\n[releases]: https://github.com/klaasnicolaas/python-odp-amsterdam/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\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous Python client providing Open Data information of Amsterdam",
"version": "6.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/klaasnicolaas/python-odp-amsterdam/issues",
"Changelog": "https://github.com/klaasnicolaas/python-odp-amsterdam/releases",
"Documentation": "https://github.com/klaasnicolaas/python-odp-amsterdam",
"Homepage": "https://github.com/klaasnicolaas/python-odp-amsterdam",
"Repository": "https://github.com/klaasnicolaas/python-odp-amsterdam"
},
"split_keywords": [
"garages",
" amsterdam",
" car",
" occupancy",
" async",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "277925a33b4d4fdf63bee32522dbcffabf4403a0a945b2caf98447109299c239",
"md5": "0fd46842af7f35729da4142341032c7e",
"sha256": "3f41cd053566837f9236037cc2d5ffbaf7bcebe181dea72f144089fa59ca96f0"
},
"downloads": -1,
"filename": "odp_amsterdam-6.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fd46842af7f35729da4142341032c7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 11185,
"upload_time": "2024-06-28T20:29:02",
"upload_time_iso_8601": "2024-06-28T20:29:02.475285Z",
"url": "https://files.pythonhosted.org/packages/27/79/25a33b4d4fdf63bee32522dbcffabf4403a0a945b2caf98447109299c239/odp_amsterdam-6.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "917637adb91b4a768731602d81c1baa097627cac46bac417918b8700a72faa7e",
"md5": "76f264b1745d36417e0fae919757cb9b",
"sha256": "9bfec38b0ddee09c096b2b4cfeb6d27b141de590dd1e0d22216195d170c02225"
},
"downloads": -1,
"filename": "odp_amsterdam-6.0.2.tar.gz",
"has_sig": false,
"md5_digest": "76f264b1745d36417e0fae919757cb9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 13367,
"upload_time": "2024-06-28T20:29:04",
"upload_time_iso_8601": "2024-06-28T20:29:04.120229Z",
"url": "https://files.pythonhosted.org/packages/91/76/37adb91b4a768731602d81c1baa097627cac46bac417918b8700a72faa7e/odp_amsterdam-6.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 20:29:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klaasnicolaas",
"github_project": "python-odp-amsterdam",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "odp-amsterdam"
}
JSON
