Asynchronous Python client for the open datasets of Stockholm (Sweden).
A python package with which you can retrieve data from the Open Data Platform of Stockholm via their 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.
pip install odp-stockholmYou can read the following datasets with this package:
To use the data you need an API key, which you can request via this link.
Click here to get more details
You can use the following parameters in your request:
- limit (default: 10) - How many results you want to retrieve.
| Variable | Type | Description |
|---|---|---|
location_id |
string | The id of the location |
location_type |
string | The type of the location |
number |
integer | How many parking spots there are on this location |
street |
string | The street name of the location |
address |
string | The address of the location |
district |
string | The district name where the location is |
parking_rate |
string | The parking rate of the location |
parking_rules |
string | URL to the parking regulations of Stockholm |
valid_from |
datetime | The date from when the parking is valid |
valid_to |
datetime (or None) | The date until when the parking is valid |
coordinates |
list[float] | The coordinates of the location |
import asyncio
from odp_stockholm import ParkingStockholm
async def main() -> None:
"""Show example on using this package."""
async with ParkingStockholm(api_key="YOUR_API_KEY") as client:
locations = await client.disabled_parkings(
limit=10,
)
print(locations)
if __name__ == "__main__":
asyncio.run(main())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.
Thank you for being involved! 😍
The simplest way to begin is by utilizing the Dev Container 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.
This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.
You need at least:
- Python 3.11+
- Poetry
Install all packages, including all development requirements:
poetry installPoetry creates by default an virtual environment where it installs all necessary pip packages.
This repository uses the pre-commit framework, all changes are linted and tested with each commit. To setup the pre-commit check, run:
poetry run pre-commit installAnd to run all checks and tests manually, use the following command:
poetry run pre-commit run --all-filesIt uses pytest as the test framework. To run the tests:
poetry run pytestTo update the syrupy snapshot tests:
poetry run pytest --snapshot-updateMIT License
Copyright (c) 2023-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.
