VigiEauPy

Asynchronous Python client for the VigiEau API, the official French service for monitoring water use restrictions during drought periods.

Installation

pip install vigieaupy

Requirements

• Python >= 3.10
• aiohttp >= 3.8.1

Usage

import asyncio
from vigieaupy import Consommateur, Source, VigiEau, VigiEauException

async def main():
    api = VigiEau()

    try:
        # Search for a commune by name or postal code
        communes = await api.async_get_cog(name="Nantes")
        # or: communes = await api.async_get_cog(codeZip=44000)

        # Fetch active water restrictions
        restrictions = await api.async_get_data(
            codeInsee=communes[0]["code"],
            source=Source.AEP,
            consommateur=Consommateur.particulier,
        )
        for restriction in restrictions:
            print(restriction)

    except VigiEauException as err:
        print(f"Error: {err}")
    finally:
        await api.async_close()

asyncio.run(main())

API

VigiEau(session=None, timeout=120)

Main client class. Optionally accepts an existing aiohttp.ClientSession and a timeout in seconds.

async_get_cog(codeZip=None, name=None)

Search for communes using the French government API (geo.api.gouv.fr).

Returns a list of matching communes.

async_get_data(codeInsee, source=None, consommateur=None)

Fetch active water restrictions for a commune.

Enum Source

Enum Consommateur

Exceptions

License

GPL-3.0-or-later — see the LICENSE file.