跳转到主要内容

GRDF ADICT API的Python客户端

项目描述

lowatt-grdf

一个用于访问由GrDF Adict API(由Lowatt提供)的命令行工具和Python库。

许可

它按照MIT许可证的条款发布。

安装

pip install lowatt-grdf

命令行用法

$ lowatt-grdf --help
Usage: lowatt-grdf [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  declare-acces
  donnees-consos-informatives
  donnees-consos-publiees
  donnees-contractuelles
  donnees-techniques
  droits-acces

每个子命令实现相关的API端点,并输出可轻松通过jq读取的json。每个命令还需要提供--client-id--client-secret,或通过相应的环境变量CLIENT_IDCLIENT_SECRET。这些访问仅由GRDF提供。

droits-acces子命令还有一个--check参数,该参数将检查同意验证

  • statut_controle_preuve必须不是Preuve en attentePreuve Vérifiée KO
  • etat_droit_acces必须是Active

此命令旨在每天在CI或cron中使用,在出现错误时发出警报,因为它将需要手动更正。

Python库用法

以下是一个访问donnees-consos-publiees端点的示例代码

from lowatt_grdf.api import API

client_id = "ID"
client_secret = "SECRET"
pce = "23000000000000"

grdf = API(client_id, client_secret)
for releve in grdf.donnees_consos_publiees(pce, from_date="2021-01-01", to_date="2021-08-23"):
  conso = releve["consommation"]
  print(conso["date_debut_consommation"], conso["date_fin_consommation"], conso["energie"])

贡献

欢迎通过GitHub仓库提交贡献。

如有更多信息需要,请通过info@lowatt.fr联系。

支持