Coder Social home page Coder Social logo

klaasnicolaas / python-muenster Goto Github PK

View Code? Open in Web Editor NEW
5.0 2.0 0.0 1.52 MB

🗃️ Asynchronous Python client for the open datasets of Münster (🇩🇪 - Germany)

Home Page: https://opendata.stadt-muenster.de

License: MIT License

Python 100.00%
api async client hacktoberfest parking python muenster opendata nipkaart

python-muenster's Introduction

alt Banner of the ODP Muenster package

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity PyPi Downloads GitHub Last Commit Open in Dev Containers

Code Quality Build Status Typing Status

Maintainability Code Coverage

Asynchronous Python client for the open datasets of Münster (Germany).

About

A python package with which you can retrieve data from the Open Data Platform of Münster 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 muenster

Datasets

You can read the following datasets with this package:

Click here to get more details

Garages

Variable Type Description
name string The name of the garage
status string The status of the garage
parking_type string The type of parking of the garage (Parkplatz or Parkhaus)
free_space integer The free space of the garage
total_capacity integer The total capacity of the garage
availability_pct float The availability percentage of the garage
url string The URL with more information of the garage
longitude float The longitude of the garage
latitude float The latitude of the garage

Example

import asyncio

from muenster import StadtMuenster


async def main() -> None:
    """Show example on using the API of Münster."""
    async with StadtMuenster() as client:
        garages = await client.garages(limit=10)
        print(garages)


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

Setting up development environment

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.

Open in Dev Containers

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

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

python-muenster's People

Contributors

dependabot[bot] avatar klaasnicolaas avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

python-muenster's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • ⬆️ Lock file maintenance

Detected dependencies

devcontainer
.devcontainer/devcontainer.json
  • ghcr.io/devcontainers/features/git 1
  • ghcr.io/devcontainers/features/github-cli 1
  • ghcr.io/devcontainers-contrib/features/poetry 2
  • ghcr.io/devcontainers-contrib/features/pre-commit 2
  • ghcr.io/devcontainers/features/common-utils 2
  • ghcr.io/devcontainers-contrib/features/zsh-plugins 0
  • ghcr.io/devcontainers/features/python 1
github-actions
.github/workflows/codeql.yaml
  • actions/checkout v4.1.6
  • github/codeql-action v3.25.8
  • github/codeql-action v3.25.8
.github/workflows/labels.yaml
  • actions/checkout v4.1.6
  • micnncim/action-label-syncer v1.3.0
.github/workflows/linting.yaml
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
.github/workflows/lock.yaml
  • dessant/lock-threads v5.0.1
.github/workflows/pr-labels.yaml
  • jesusvasquez333/verify-pr-label-action v1.4.0
.github/workflows/release-drafter.yaml
  • release-drafter/release-drafter v6.0.0
.github/workflows/release.yaml
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • Eomm/why-don-t-you-tweet v2.0.0
.github/workflows/stale.yaml
  • actions/stale v9.0.0
.github/workflows/tests.yaml
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
  • actions/upload-artifact v4.3.3
  • actions/checkout v4.1.6
  • actions/download-artifact v4.1.7
  • actions/setup-python v5.1.0
  • codecov/codecov-action v4.4.1
.github/workflows/typing.yaml
  • actions/checkout v4.1.6
  • actions/setup-python v5.1.0
pep621
pyproject.toml
  • poetry-core >=1.0.0
poetry
pyproject.toml
  • aiohttp >=3.0.0
  • python ^3.11
  • yarl >=1.6.0
  • pyproj ^3.3.1
  • aresponses 3.0.0
  • codespell 2.3.0
  • covdefaults 2.3.0
  • coverage 7.5.3
  • mypy 1.10.0
  • pre-commit 3.7.1
  • pre-commit-hooks 4.6.0
  • pylint 3.2.3
  • pytest 8.2.2
  • pytest-asyncio 0.23.7
  • pytest-cov 5.0.0
  • ruff 0.4.8
  • yamllint 1.35.1

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.