{ "info": { "author": "Stephane Senart", "author_email": "stephane.senart@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Build Tools" ], "description": "# PyGazpar\nPyGazpar is a Python library for getting natural gas consumption from GrDF French provider.\n\nTheir natural gas meter is called Gazpar. It is wireless and transmit the gas consumption once per day.\n\nAll consumption data is available on the client account at GrDF Web Site (https://monespace.grdf.fr).\n\nPyGazpar automatically go through the Web Site and download the consumption data Excel file, and make it available in a Python structure (list of dictionaries).\n\n## Installation\n\n### Requirements\nPyGazpar is working with Selenium Python library to automate navigation through GrDF Web site. Selenium requires a WebDriver that acts as gateway between automatic actions from PyGazpar and a native browser already installed on the system.\n\nPyGazpar has been developped and tested with Firefox browser (version 68.8) and its corresponding Web Driver geckodriver (version 0.24).\n\n#### Firefox browser installation\nFollow instructions [here](https://www.mozilla.org/fr/firefox/new)\n\n#### Firefox Web Driver (geckodriver) installation\nFollow instructions [here](https://github.com/mozilla/geckodriver/releases)\n\n### Create your virtual environment\n```bash\n$ pip install virtualenv\n\n$ cd /path/to/my_project_folder/\n\n$ virtualenv venv\n```\n\n### PyGazpar installation\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install PyGazpar.\n\n```bash\npip install pygazpar\n```\n\nYou can also download the source code and install it manually.\n\n```bash\ncd /path/to/pygazpar/\npython setup.py install\n```\n\n## Usage\n\n### Command line\n\n```bash\n$ pygazpar -u 'your login' -p 'your password' -w 'path/to/Selenium Web Driver' -s 30 -t 'temporary directory where to store XSLX file (ex: /tmp)'\n```\n\n### Library\n\n```python\nimport pygazpar\n\nclient = pygazpar.Client('your login',\n 'your password',\n 'path/to/Selenium Web Driver',\n 30,\n 'temporary directory where to store XSLX file (ex: /tmp)')\n\nclient.update()\n\ndata = client.data()\n```\n\n### Output\n\n```json\ndata =>\n[\n {\n \"date\": \"01/07/2019\",\n \"start_index_m3\": 9802.0,\n \"end_index_m3\": 9805.0,\n \"volume_m3\": 3.6,\n \"energy_kwh\": 40.0,\n \"converter_factor\": \"11,244\",\n \"local_temperature\": \"\",\n \"type\": \"MES\",\n \"timestamp\": \"2019-08-29T16:56:07.380422\"\n },\n {\n \"date\": \"02/07/2019\",\n \"start_index_m3\": 9805.0,\n \"end_index_m3\": 9808.0,\n \"volume_m3\": 2.8,\n \"energy_kwh\": 31.0,\n \"converter_factor\": \"11,244\",\n \"local_temperature\": \"21\",\n \"type\": \"MES\",\n \"timestamp\": \"2019-08-29T16:56:07.380422\"\n },\n {\n \"date\": \"03/07/2019\",\n \"start_index_m3\": 9808.0,\n \"end_index_m3\": 9811.0,\n \"volume_m3\": 2.9,\n \"energy_kwh\": 33.0,\n \"converter_factor\": \"11,244\",\n \"local_temperature\": \"\",\n \"type\": \"MES\",\n \"timestamp\": \"2019-08-29T16:56:07.380422\"\n }\n]\n```\n\n## Limitation\nPyGazpar relies on how GrDF Web Site is built. It goes through each Web pages and automatically fill forms, click buttons using their internal identifiers.\n\nAny change in the Web site structure or identifier naming may break this library.\n\nWe expect in close Future that GrDF makes available a standard API from which we can get safely their data.\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n\n## Project status\nPyGazpar has been initiated for integration with [Home Assistant](https://www.home-assistant.io/). This integration work is still on-going.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/ssenart/pygazpar/releases/tag/0.1.9", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ssenart/PyGazpar", "keywords": "ENERGY,NATURAL GAS,CONSUMPTION", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pygazpar", "package_url": "https://pypi.org/project/pygazpar/", "platform": "", "project_url": "https://pypi.org/project/pygazpar/", "project_urls": { "Download": "https://github.com/ssenart/pygazpar/releases/tag/0.1.9", "Homepage": "https://github.com/ssenart/PyGazpar" }, "release_url": "https://pypi.org/project/pygazpar/0.1.9/", "requires_dist": null, "requires_python": ">=3.7", "summary": "Retrieve gas consumption from GrDF web site (French Gas Company)", "version": "0.1.9" }, "last_serial": 5765333, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "6c11dbd7758dbf19fc5587b2c5b00033", "sha256": "8e734645ccfa06070f864efd97d4228e01eaa04566d3f6b5c2631af8593a3ec9" }, "downloads": -1, "filename": "pygazpar-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6c11dbd7758dbf19fc5587b2c5b00033", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3731, "upload_time": "2019-08-23T13:56:31", "url": "https://files.pythonhosted.org/packages/e2/f3/95655dd3088ef1081111f34e7f652f515c6a76f28cf316243915bf315bc2/pygazpar-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "20aaae6855639e27f8f91615aa25bc9e", "sha256": "77dfc563d12fec4f7f97fd5f3fda8edd8603744b9890e02f4228f2ec921df210" }, "downloads": -1, "filename": "pygazpar-0.1.2.tar.gz", "has_sig": false, "md5_digest": "20aaae6855639e27f8f91615aa25bc9e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3747, "upload_time": "2019-08-25T20:20:04", "url": "https://files.pythonhosted.org/packages/a9/5c/ac8a0f2f5ca6b309afb650d2c88edee5ed53996e140a2694c2a983997094/pygazpar-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "b6ccc5370b601d7247656e7da903bf9f", "sha256": "6c165575780a95a65552eef5d7c049180c2240c6b738b6c716d7adacdfff150c" }, "downloads": -1, "filename": "pygazpar-0.1.3.tar.gz", "has_sig": false, "md5_digest": "b6ccc5370b601d7247656e7da903bf9f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3773, "upload_time": "2019-08-25T21:18:59", "url": "https://files.pythonhosted.org/packages/fd/da/e8d1de2149f89ba5ea6866111f072ecc56d356a5d8dd72121cc3a404d0ec/pygazpar-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "65aecbfdc25c5fe2577390fc717b6b91", "sha256": "3c393e281f96f2c3ec6833896d5c5a55880de19e312289959a57c5a5656bb232" }, "downloads": -1, "filename": "pygazpar-0.1.4.tar.gz", "has_sig": false, "md5_digest": "65aecbfdc25c5fe2577390fc717b6b91", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3773, "upload_time": "2019-08-25T21:40:19", "url": "https://files.pythonhosted.org/packages/c2/5e/c8e14fcea818d67c90a2177ef249a55e7523d6b4c3eb53b1f67bf2e1677b/pygazpar-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "97bf965a11f29c77d88617232accc9b7", "sha256": "33fad072f0d33db541b67460a1b4d240ba2b7d87c9ced15ab91e8e2130debdd7" }, "downloads": -1, "filename": "pygazpar-0.1.5.tar.gz", "has_sig": false, "md5_digest": "97bf965a11f29c77d88617232accc9b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3782, "upload_time": "2019-08-25T21:56:01", "url": "https://files.pythonhosted.org/packages/2d/fd/4f787bcbd40eb10eb9aaa5aad335e01d20dadbe91b20ad94e831a0fd0ac6/pygazpar-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "7cb0a9d4f033d79c934ea73f0d1cac7d", "sha256": "7520da7db1cc50e0ee3d01022d42f863c5f347c92c2c3f5bd38500507bd60460" }, "downloads": -1, "filename": "pygazpar-0.1.6.tar.gz", "has_sig": false, "md5_digest": "7cb0a9d4f033d79c934ea73f0d1cac7d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5087, "upload_time": "2019-08-26T12:29:25", "url": "https://files.pythonhosted.org/packages/95/e4/dbdd47bee2dfed8e12980d602cb616f61fd9c88849781b3a24ddb9d2c075/pygazpar-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "c42e1da6767f3652e3a02fa847043d1c", "sha256": "22781ce1b097569c1b618728445e3e607f7997406e5e6060972c94c25064490b" }, "downloads": -1, "filename": "pygazpar-0.1.7.tar.gz", "has_sig": false, "md5_digest": "c42e1da6767f3652e3a02fa847043d1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5841, "upload_time": "2019-08-29T15:30:11", "url": "https://files.pythonhosted.org/packages/ec/98/37513d2ccc7596960d7ea495deef88ed0525816c6943094e96567dca3677/pygazpar-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "01e3e632a40a9fd3c9c27ac853502332", "sha256": "77e119bae84c65516d2fa5413161b50ca42fff9e18d94cb2d5c90c1d5bb00813" }, "downloads": -1, "filename": "pygazpar-0.1.8.tar.gz", "has_sig": false, "md5_digest": "01e3e632a40a9fd3c9c27ac853502332", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 6333, "upload_time": "2019-08-31T15:19:05", "url": "https://files.pythonhosted.org/packages/75/42/35f56402bbf2c3ec601bf1ce4c1803149f40a2bb536b51e6e9cd3b34560b/pygazpar-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "2e2eb0447c6f61b2da4277e9fadf6641", "sha256": "849946fbe7d3ff00bd55c7e1d724bbeefe0f7c54b321fb19ab06731842b2e2e8" }, "downloads": -1, "filename": "pygazpar-0.1.9.tar.gz", "has_sig": false, "md5_digest": "2e2eb0447c6f61b2da4277e9fadf6641", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 6361, "upload_time": "2019-08-31T21:04:41", "url": "https://files.pythonhosted.org/packages/f8/9c/c1f7b49902ea8aafd751a4743a59e3ddc887f2d6a50ea4531a1a474df0ad/pygazpar-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2e2eb0447c6f61b2da4277e9fadf6641", "sha256": "849946fbe7d3ff00bd55c7e1d724bbeefe0f7c54b321fb19ab06731842b2e2e8" }, "downloads": -1, "filename": "pygazpar-0.1.9.tar.gz", "has_sig": false, "md5_digest": "2e2eb0447c6f61b2da4277e9fadf6641", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 6361, "upload_time": "2019-08-31T21:04:41", "url": "https://files.pythonhosted.org/packages/f8/9c/c1f7b49902ea8aafd751a4743a59e3ddc887f2d6a50ea4531a1a474df0ad/pygazpar-0.1.9.tar.gz" } ] }