Skip to main content

Asynchronous Python client providing Open Data information of Amsterdam

Project description

alt Header of the odp Amsterdam package

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity PyPi Downloads GitHub Last Commit Stargazers Issues

Code Quality Build Status Typing Status

Maintainability Code Coverage

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

pip install odp-amsterdam

Datasets

You can read the following datasets with this package:

Click here to get more details

Parking garages

Read the occupancy of a parking garage in Amsterdam (The Netherlands), both for day visitors (short-term parking) and season ticket holders (long-term parking).

NOTE: Not all parking garages have data for long-term parking.

Variable Type Description
garage_id string The id of the garage
garage_name string The name of the garage
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

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

Usage

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

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.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager.

You need at least:

Install all packages, including all development requirements:

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:

poetry shell
exit

Setup the pre-commit check, you must run this inside the virtual environment:

pre-commit install

Now you're all set to get started!

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

License

MIT License

Copyright (c) 2020-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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odp_amsterdam-5.0.1.tar.gz (12.8 kB view hashes)

Uploaded source

Built Distribution

odp_amsterdam-5.0.1-py3-none-any.whl (10.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page