Metadata-Version: 2.1
Name: meteoalarm_rssapi
Version: 0.1.7
Summary: An "API" for meteoalarm.eu using the rss feeds.
Home-page: https://github.com/xlcnd/meteoalarm-rssapi
Author: xlcnd
Author-email: xlcnd@outlook.com
License: GPL v3
Download-URL: https://github.com/xlcnd/meteoalarm-rssapi/archive/v0.1.7.zip
Project-URL: Bug Reports, https://github.com/xlcnd/meteoalarm-rssapi/issues
Project-URL: License, https://github.com/xlcnd/meteoalarm-rssapi/blob/dev/LICENSE.txt
Description: [![GitHub tests](https://github.com/xlcnd/meteoalarm-rssapi/workflows/tests/badge.svg)][2]
        [![GitHub issues by-label](https://img.shields.io/github/issues/xlcnd/meteoalarm-rssapi/bug?label=bugs)][3]
        [![PyPI](https://img.shields.io/pypi/v/meteoalarm-rssapi)][1]
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/meteoalarm-rssapi)][1]
        
        
        An API for [meteoalarm.eu](https://www.meteoalarm.eu/) weather alerts.
        
        To install enter in a command line:
        
        ```
        pip install meteoalarm-rssapi
        ```
        
        Now, lets see a simple example:
        
        ```python
        from meteoalarm_rssapi import MeteoAlarm
        meteo = MeteoAlarm('DE', 'Kreis Ahrweiler')
        
        print(meteo.alerts())
        ```
        
        
        and you will get (after some `pprint`):
        
        ```
        alert_id: 3820923534
        message_id: 1817809724
        awareness_type: Snow/Ice
        awareness_level: Yellow
        country: DE
        region: Kreis Ahrweiler
        published: 2021-01-26T12:23:00+01:00
        from: 2021-01-26T18:00:00+01:00
        until: 2021-01-27T11:00:00+01:00
        message:
          deutsch: Es tritt im Warnzeitraum oberhalb 400 m leichter
          Schneefall mit Mengen zwischen 1 cm und 3 cm auf. In Staulagen
          werden Mengen bis 5 cm erreicht. Die Schneefallgrenze steigt auf
          1500 Meter. Verbreitet wird es glatt.
          english: There is a risk of light snowfall (Level 1 of 4).
          Height range: > 400 m;
          Precipitation amounts: 1-3 cm; in windward areas: < 5 cm;
          snowfall level: rising to 1500 meter
        ```
        
        
        You need to know your iso 2-letter country code (e.g. DE) and the **exact name** of your region
        **as reported by your national agency to meteoalarm.eu** (e.g. Kreis Ahrweiler). For that, 
        please check the page for your country in [meteoalarm.eu](https://www.meteoalarm.eu/),
        or run the following script:
        
        ```python
        from meteoalarm_rssapi import get_regions
        
        print(get_regions('DE'))
        ```
        
        
        The timestamps for `published`, `from` and `until` are in ISO8601 format, so that you can 
        (*easily*) convert them to your local date/time. 
        
        
        There are two pieces of information that could be important for your applications:
        
        1. `alert_id` changes to a new value when there is a change in the `message` or in the 
           day/month of `from`. So, doesn't change if there are only a revision of the H:M, a revision
           for `until` or a change in the `awareness_level`.
        2. `message_id` changes with any change in `message`, `published`, `from`, `until` or `awareness_level`.
        
        In conclusion, for one `alert_id` there are several `message_id` 
        (that can be taken as the revisions of the `alert_id`).
        
        
        [1]: https://pypi.org/project/meteoalarm-rssapi/
        [2]: https://github.com/xlcnd/meteoalarm-rssapi/actions
        [3]: https://github.com/xlcnd/meteoalarm-rssapi/issues?q=is%3Aissue+is%3Aopen+is%3Abug
        
        
Keywords: meteoalarm
Platform: any
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
