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 Docs| |Tests| |Codecov| |GitHub Activity|
|pre-commit| |Black|
.. |PyPI| image:: https://img.shields.io/pypi/v/meteofrance-api
:target: https://pypi.org/project/meteofrance-api/
:alt: PyPI
.. |GitHub Release| image:: https://img.shields.io/github/release/hacf-fr/meteofrance-api.svg
:target: https://github.com/hacf-fr/meteofrance-api/releases
:alt: GitHub Release
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/meteofrance-api
:target: https://pypi.org/project/meteofrance-api/
:alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/meteofrance-api
:target: https://opensource.org/licenses/MIT
:alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/meteofrance-api/latest.svg?label=Read%20the%20Docs
:target: https://meteofrance-api.readthedocs.io/
:alt: Read the documentation at https://meteofrance-api.readthedocs.io/
.. |Tests| image:: https://github.com/hacf-fr/meteofrance-api/workflows/Tests/badge.svg
:target: https://github.com/hacf-fr/meteofrance-api/actions?workflow=Tests
:alt: Tests
.. |Codecov| image:: https://codecov.io/gh/hacf-fr/meteofrance-api/branch/master/graph/badge.svg
:target: https://codecov.io/gh/hacf-fr/meteofrance-api
:alt: Codecov
.. |GitHub Activity| image:: https://img.shields.io/github/commit-activity/y/hacf-fr/meteofrance-api.svg
:target: https://github.com/hacf-fr/meteofrance-api/commits/master
:alt: GitHub Activity
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: 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 <https://vigilance.meteofrance.fr/fr/gers>`_).
Ce package a été développé avec l'intention d'être utilisé par `Home-Assistant <https://home-assistant.io/>`_
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_:
.. code:: console
$ pip install meteofrance-api
Vous pouvez trouver un exemple d'usage dans un module Python en regardant
`le test d'intégration <tests/test_integrations.py>`_.
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 phenomenoms for each French department or Andorre.
Two bulletin are availabe: one basic and an other advanced with the timelaps evolution
for the next 24 hours (example `here <https://vigilance.meteofrance.fr/fr/gers>`_).
This package have been developed to be used with `Home-Assistant <https://home-assistant.io/>`_
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_:
.. code:: console
$ pip install meteofrance-api
You will find an example ot usage in a Python program in the `integration test <tests/test_integrations.py>`_.
Contributing
^^^^^^^^^^^^
Contributions are welcomed. Please check the guidelines in `CONTRIBUTING.rst`_.
Credits
-------
This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _pip: https://pip.pypa.io/
.. github-only
.. _CONTRIBUTING.rst: CONTRIBUTING.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/hacf-fr/meteofrance-api",
"name": "meteofrance-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.18,<4.0.0",
"maintainer_email": "",
"keywords": "weather,weather-api,meteo",
"author": "oncleben31",
"author_email": "oncleben31@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/18/55/1a1a83fe7eeb8daab3cabfd55f973fb7f822f2c10b5120f292d1c321521b/meteofrance_api-1.3.0.tar.gz",
"platform": null,
"description": "M\u00e9t\u00e9o-France Python API\n=======================\n\nClient Python pour l'API M\u00e9t\u00e9o-France. | Python client for M\u00e9t\u00e9o-France API.\n\n|PyPI| |GitHub Release| |Python Version| |License|\n\n|Read the Docs| |Tests| |Codecov| |GitHub Activity|\n\n|pre-commit| |Black|\n\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/meteofrance-api\n :target: https://pypi.org/project/meteofrance-api/\n :alt: PyPI\n.. |GitHub Release| image:: https://img.shields.io/github/release/hacf-fr/meteofrance-api.svg\n :target: https://github.com/hacf-fr/meteofrance-api/releases\n :alt: GitHub Release\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/meteofrance-api\n :target: https://pypi.org/project/meteofrance-api/\n :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/meteofrance-api\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/meteofrance-api/latest.svg?label=Read%20the%20Docs\n :target: https://meteofrance-api.readthedocs.io/\n :alt: Read the documentation at https://meteofrance-api.readthedocs.io/\n.. |Tests| image:: https://github.com/hacf-fr/meteofrance-api/workflows/Tests/badge.svg\n :target: https://github.com/hacf-fr/meteofrance-api/actions?workflow=Tests\n :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/hacf-fr/meteofrance-api/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/hacf-fr/meteofrance-api\n :alt: Codecov\n.. |GitHub Activity| image:: https://img.shields.io/github/commit-activity/y/hacf-fr/meteofrance-api.svg\n :target: https://github.com/hacf-fr/meteofrance-api/commits/master\n :alt: GitHub Activity\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\nYou will find English README content in the section `For English speaking users`_.\n\nVous trouverez le contenu francophone du README dans la section `Pour les francophones`_.\n\nPour les francophones\n---------------------\n\nDescription\n^^^^^^^^^^^\n\nCe package Python permet de g\u00e9rer la communication avec l'API non publique de\nM\u00e9t\u00e9o-France utilis\u00e9e par les applications mobiles officielles.\n\nLe client permet:\n\n* Rechercher des lieux de pr\u00e9visions.\n* Acc\u00e9der aux pr\u00e9visions m\u00e9t\u00e9orologiques horaires ou quotidiennes.\n* Acc\u00e9der aux pr\u00e9visions de pluie dans l'heure quand disponibles.\n* Acc\u00e9der aux alertes m\u00e9t\u00e9o pour chaque d\u00e9partement fran\u00e7ais et d'Andorre. Deux\n bulletins sont disponibles : un synth\u00e9tique et un second avec l'\u00e9volution des alertes\n pour les prochaines 24 heures (exemple `ici <https://vigilance.meteofrance.fr/fr/gers>`_).\n\nCe package a \u00e9t\u00e9 d\u00e9velopp\u00e9 avec l'intention d'\u00eatre utilis\u00e9 par `Home-Assistant <https://home-assistant.io/>`_\nmais il peut \u00eatre utilis\u00e9 dans d'autres contextes.\n\nInstallation\n^^^^^^^^^^^^\n\nPour utiliser le module Python ``meteofrance`` vous devez en premier installer\nle package en utilisant pip_ depuis PyPI_:\n\n.. code:: console\n\n $ pip install meteofrance-api\n\n\nVous pouvez trouver un exemple d'usage dans un module Python en regardant\n`le test d'int\u00e9gration <tests/test_integrations.py>`_.\n\nContribuer\n^^^^^^^^^^\n\nLes contributions sont les bienvenues. Veuillez consulter les bonnes pratiques\nd\u00e9taill\u00e9es dans `CONTRIBUTING.rst`_.\n\n\nFor English speaking users\n--------------------------\n\nDescription\n^^^^^^^^^^^^\n\nThis Python package manages the communication with the private M\u00e9t\u00e9o-France API\nused by the official mobile applications.\n\nThe client allows:\n\n* Search a forecast location.\n* Fetch daily or hourly weather forecast.\n* Fetch rain forecast within the next hour if available.\n* Fetch the weather alerts or phenomenoms for each French department or Andorre.\n Two bulletin are availabe: one basic and an other advanced with the timelaps evolution\n for the next 24 hours (example `here <https://vigilance.meteofrance.fr/fr/gers>`_).\n\nThis package have been developed to be used with `Home-Assistant <https://home-assistant.io/>`_\nbut it can be used in other contexts.\n\nInstallation\n^^^^^^^^^^^^\n\nTo use the ``meteofrance`` Python module, you have to install this package first via\npip_ from PyPI_:\n\n.. code:: console\n\n $ pip install meteofrance-api\n\nYou will find an example ot usage in a Python program in the `integration test <tests/test_integrations.py>`_.\n\nContributing\n^^^^^^^^^^^^\n\nContributions are welcomed. Please check the guidelines in `CONTRIBUTING.rst`_.\n\nCredits\n-------\n\nThis project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.\n\n.. _@cjolowicz: https://github.com/cjolowicz\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _PyPI: https://pypi.org/\n.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n.. _pip: https://pip.pypa.io/\n\n.. github-only\n.. _CONTRIBUTING.rst: CONTRIBUTING.rst\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for M\u00e9t\u00e9o-France API.",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/hacf-fr/meteofrance-api/releases",
"Documentation": "https://meteofrance-api.readthedocs.io",
"Homepage": "https://github.com/hacf-fr/meteofrance-api",
"Repository": "https://github.com/hacf-fr/meteofrance-api"
},
"split_keywords": [
"weather",
"weather-api",
"meteo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ad7949148abc4eb89f9b89ad81816e251fa07c0f140a48a036974c147ebd6a8",
"md5": "8753104b8dcdf5ca2afbec4334e3c21f",
"sha256": "eafd1f817caa30b9f37d0fa8b941a58f137c93d7557d6f1eb533e03642c68486"
},
"downloads": -1,
"filename": "meteofrance_api-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8753104b8dcdf5ca2afbec4334e3c21f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.18,<4.0.0",
"size": 22154,
"upload_time": "2023-12-06T23:08:34",
"upload_time_iso_8601": "2023-12-06T23:08:34.645711Z",
"url": "https://files.pythonhosted.org/packages/4a/d7/949148abc4eb89f9b89ad81816e251fa07c0f140a48a036974c147ebd6a8/meteofrance_api-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18551a1a83fe7eeb8daab3cabfd55f973fb7f822f2c10b5120f292d1c321521b",
"md5": "452383346776903b57177593fab7e3e7",
"sha256": "895a243f4fc7b352d8d533afee7b6b351677e1ab66b1c7ac14aae25b6214b1dc"
},
"downloads": -1,
"filename": "meteofrance_api-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "452383346776903b57177593fab7e3e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.18,<4.0.0",
"size": 17827,
"upload_time": "2023-12-06T23:08:35",
"upload_time_iso_8601": "2023-12-06T23:08:35.990045Z",
"url": "https://files.pythonhosted.org/packages/18/55/1a1a83fe7eeb8daab3cabfd55f973fb7f822f2c10b5120f292d1c321521b/meteofrance_api-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 23:08:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hacf-fr",
"github_project": "meteofrance-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meteofrance-api"
}
JSON
