/meteofrance-api

Python client for Météo-France API. | Client python pour l'API Météo-France

Primary LanguagePythonMIT LicenseMIT

Météo-France Python API

Client Python pour l'API Météo-France. | Python client for Météo-France API.

PyPI GitHub Release Python Version License

Read the documentation at https://meteofrance-api.readthedocs.io/ Tests Codecov GitHub Activity

pre-commit Black

You will find English README content in the section For English speaking users.

Vous trouverez le contenu francophone du README dans la section Pour les francophones.

Pour les francophones

Description

Ce package Python permet de gérer la communication avec l'API non publique de Météo-France utilisée par les applications mobiles officielles.

Le client permet:

  • Rechercher des lieux de prévisions.
  • Accéder aux prévisions météorologiques horaires ou quotidiennes.
  • Accéder aux prévisions de pluie dans l'heure quand disponibles.
  • Accéder aux alertes météo pour chaque département français et d'Andorre. Deux bulletins sont disponibles : un synthétique et un second avec l'évolution des alertes pour les prochaines 24 heures (exemple ici).

Ce package a été développé avec l'intention d'être utilisé par Home-Assistant mais il peut être utilisé dans d'autres contextes.

Installation

Pour utiliser le module Python meteofrance vous devez en premier installer le package en utilisant pip depuis PyPI:

$ pip install meteofrance-api

Vous pouvez trouver un exemple d'usage dans un module Python en regardant le test d'intégration.

Contribuer

Les contributions sont les bienvenues. Veuillez consulter les bonnes pratiques détaillées dans CONTRIBUTING.rst.

For English speaking users

Description

This Python package manages the communication with the private Météo-France API used by the official mobile applications.

The client allows:

  • Search a forecast location.
  • Fetch daily or hourly weather forecast.
  • Fetch rain forecast within the next hour if available.
  • Fetch the weather alerts or phenomenons for each French department or Andorre. Two bulletin are available: one basic and an other advanced with the timelaps evolution for the next 24 hours (example here).

This package have been developed to be used with Home-Assistant but it can be used in other contexts.

Installation

To use the meteofrance Python module, you have to install this package first via pip from PyPI:

$ pip install meteofrance-api

You will find an example ot usage in a Python program in the integration test.

Contributing

Contributions are welcomed. Please check the guidelines in CONTRIBUTING.rst.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.