Skip to main content

Asynchronous Python client for the Eiswarnung API

Project description

alt Banner of the Eiswarnung 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 Eiswarnung API.

About

A python package with which you can read data from Eiswarnung API. This way you know whether it is necessary to scratch your car window the next day, because there is a layer of ice on it. This service comes from Germany but should work in other countries as well.

Installation

pip install eiswarnung

Usage

For a successful request, you must fill in the latitude and longitude data and have a valid API key, which you can request via this website. Note: there is a limit of 50 requests per day.

import asyncio

from eiswarnung import Eiswarnung


async def main():
    """Show example on getting data from the Eiswarnung API."""
    async with Eiswarnung(
        api_key="API_KEY",
        latitude=49.17,
        longitude=11.10,
    ) as client:
        forecast = await client.forecast()
        print(forecast)
        print(client.ratelimit)


if __name__ == "__main__":
    asyncio.run(main())

Data

You can read the following data with this package:

Forecast

  • Request date (datetime)
  • Status ID (int)
  • Forecast Type - in English (str)
  • Forecast Text - in German (str)
  • Forecast City (str)
  • Forecast Date - the next day (datetime)

Ratelimit

  • Call Limit (int)
  • Remaining Calls (int)
  • Retry after (remaining seconds)

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

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) 2021-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

eiswarnung-2.0.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

eiswarnung-2.0.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file eiswarnung-2.0.0.tar.gz.

File metadata

  • Download URL: eiswarnung-2.0.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for eiswarnung-2.0.0.tar.gz
Algorithm Hash digest
SHA256 c4fa6c56a758615d59700c7b6f7544ba32050b19cf0457167aa6bdcb59b7936f
MD5 a59b9aaefcf69da0be3fbe1c391efa25
BLAKE2b-256 c620a5ecb5846636ff4263593faff4480b6572812aa7cb40fdeb8c8c765fceea

See more details on using hashes here.

File details

Details for the file eiswarnung-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: eiswarnung-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for eiswarnung-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf044e97d7e6def51ec96263ff6a7656ced526d217e9aa845bfecc9ccd371379
MD5 85e8e60d750eb52347a60bfe927945b0
BLAKE2b-256 8de2e26228a333305086960b831cd80a180056086baf5c9d4d684babd92322a1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page