Skip to main content

python API python to get active weather alerts fromhttp://vigilance.meteofrance.com/

Project description

Vigilance Météo

Build Status codecov PyPI version License: MIT

Vigilance Météo provides a python API to fetch weather alerts in France or Andorre from Météo France (http://vigilance.meteofrance.com) website.

Classes descritpion

VigilanceMeteoFranceProxy class manages the communication with the source website. The algorithm request a cheksum tiny file to download and update the XML source only when needed.

DepartmentWeatherAlert class allows to fetch all weather alerts for a french department or Andorre. Each DepartmenWeatherAlert instance can have its own proxy, but you should use only one proxy for all DepartmenWeatherAlert instances in your program to avoid too much HTTP request on source website.

Public attributes from DepartmentWeatherAlert class

  • department_color: return the overall criticity color for the department
  • additional_info_URL: return the URL to access more information about department weather alerts from the MétéoFrance website
  • bulletin_date: return the latest bulletin update date & time with timezone
  • department: get or set the department number corresponding to the area watched
  • alerts_list: return the list of all alert types
  • proxy: return the client (a VigilanceMeteoFranceProxy instance) used by the object

Public methods from DepartmentWeatherAlert class

  • update_department_status(): update alerts list by feching latest info from MétéoFrance forcast.
  • summary_message(format): return a string with textual synthesis of the active alerts in department. According to value of 'format' parameter, the string return change: 'text' (default) or 'html'

Public attributes from VigilanceMeteoFranceProxy class

  • xml_tree = XML representation of the weather alert bulletin
  • bulletin_date = Date of the bulletin (with timezone)
  • checksum = Checksum of the weather alert bulletin
  • status = current status of the proxy (possible value in constant.py)

Public Methods from VigilanceMeteoFranceProxyclass

  • update_date(): Check if new information are available and download them if any.
  • get_alert_list(department): of a given department return the list of the alerts.

Examples

>>>import vigilancemeteo

>>>zone = vigilancemeteo.DepartmentWeatherAlert('92')

>>>zone.department_color
'Jaune'

>>>zone.additional_info_URL
'http://vigilance.meteofrance.com/Bulletin_sans.html?a=dept75&b=1&c='

>>>zone.summary_message('text')
'Alerte météo Jaune en cours :\n - Vent violent: Jaune'

Installation

You can use the official release using the pyPi package. Install it with the command: pip install vigilancemeteo

Contribute

If you want to contribute to the development:

  • Start by cloning this repository.
  • Setup a virtual environment
  • Install the python package in edition mode: pip install -e .
  • Create a branch for your feature
  • Test your change using tox
  • Send a PR when ready.

References

Thank you to Lunarok to show an implementation example in PHP for Jeedom. Lot of inspiration for the first python implementation.

Since release 3.0.0, the python implementation use the the recommendation made by Météo France on www.data.gouv.fr.

License

This software is under the MIT License.

Project details


Download files

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

Files for vigilancemeteo, version 3.0.1
Filename, size File type Python version Upload date Hashes
Filename, size vigilancemeteo-3.0.1-py3-none-any.whl (10.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size vigilancemeteo-3.0.1.tar.gz (11.5 kB) File type Source Python version None Upload date Hashes View

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page