PyGazpar is a Python library for getting natural gas consumption from GrDF French provider.
Their natural gas meter is called Gazpar. It is wireless and transmit the gas consumption once per day.
All consumption data is available on the client account at GrDF Web Site (https://monespace.grdf.fr).
PyGazpar automatically goes through the Web Site and download the consumption data, and make it available in a Python structure.
PyGazpar does not require Selenium and corresponding geckodriver to work.
With the new GrDF web site, it is possible to load the consumption data far easily than before.
$ cd /path/to/my_project_folder/
$ python -m venv .venv
Activate your virtual environment.
source .venv/bin/activate
Use the package manager pip to install PyGazpar.
pip install pygazpar
You can also download the source code and install it manually.
cd /path/to/pygazpar/
python setup.py install
$ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' --datasource 'json'
$ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' -t 'temporary directory where to store Excel file (ex: /tmp)' --datasource 'excel'
$ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' --datasource 'test'
import pygazpar
client = pygazpar.Client(pygazpar.JsonWebDataSource(
username='your login',
password='your password')
)
data = client.loadSince(pceIdentifier='your PCE identifier',
lastNDays=60,
frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
See samples/jsonSample.py file for the full example.
import pygazpar
client = pygazpar.Client(pygazpar.ExcelWebDataSource(
username='your login',
password='your password')
)
data = client.loadSince(pceIdentifier='your PCE identifier',
lastNDays=60,
frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
See samples/excelSample.py file for the full example.
import pygazpar
client = pygazpar.Client(pygazpar.TestDataSource())
data = client.loadSince(pceIdentifier='your PCE identifier',
lastNDays=10,
frequencies=[pygazpar.Frequency.DAILY, Frequency.MONTHLY])
See samples/testSample.py file for the full example.
data =>
{
"daily": [
{
"time_period": "13/10/2022",
"start_index_m3": 15724,
"end_index_m3": 15725,
"volume_m3": 2,
"energy_kwh": 17,
"converter_factor_kwh/m3": 11.16,
"temperature_degC": null,
"type": "Mesur\u00e9",
"timestamp": "2022-12-13T23:58:35.606763"
},
...
{
"time_period": "11/12/2022",
"start_index_m3": 16081,
"end_index_m3": 16098,
"volume_m3": 18,
"energy_kwh": 201,
"converter_factor_kwh/m3": 11.27,
"temperature_degC": -1.47,
"type": "Mesur\u00e9",
"timestamp": "2022-12-13T23:58:35.606763"
}
],
"monthly": [
{
"time_period": "Novembre 2022",
"start_index_m3": 15750,
"end_index_m3": 15950,
"volume_m3": 204,
"energy_kwh": 2227,
"timestamp": "2022-12-13T23:58:35.606763"
},
{
"time_period": "D\u00e9cembre 2022",
"start_index_m3": 15950,
"end_index_m3": 16098,
"volume_m3": 148,
"energy_kwh": 1664,
"timestamp": "2022-12-13T23:58:35.606763"
}
]
}
PyGazpar relies on how GrDF Web Site is built.
Any change in the Web site may break this library.
We expect in close Future that GrDF makes available an open API from which we can get safely their data.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
PyGazpar has been initiated for integration with Home Assistant.
Corresponding Home Assistant integration custom component is available here.
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
#64: [Issue] Captcha failed issue.
#63: [Bug] If the latest received consumption is Sunday, then the last weekly period is duplicated.
#59: [Feature] Support both Excel and Json data source format from GrDF site.
#60: [Feature] Permit to load data at multiple frequencies with one method call.
#47: [Bug] No temperature field available.
#58: [Issue] No data update - GrDF web site is half broken - Download button does not work anymore.
MIT License
Copyright (c) 2019 Stéphane Senart
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Retrieve gas consumption from GrDF web site (French Gas Company)
We found that pygazpar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.