pygazpar 0.1.21__py3-none-any.whl → 1.3.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,225 @@
1
+ Metadata-Version: 2.3
2
+ Name: pygazpar
3
+ Version: 1.3.0
4
+ Summary: Python library to download gas consumption from a GrDF (French Gas Company) account
5
+ License: MIT License
6
+
7
+ Copyright (c) 2025 Stéphane Senart
8
+
9
+ Permission is hereby granted, free of charge, to any person obtaining a copy
10
+ of this software and associated documentation files (the "Software"), to deal
11
+ in the Software without restriction, including without limitation the rights
12
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
+ copies of the Software, and to permit persons to whom the Software is
14
+ furnished to do so, subject to the following conditions:
15
+
16
+ The above copyright notice and this permission notice shall be included in all
17
+ copies or substantial portions of the Software.
18
+
19
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
+ SOFTWARE.
26
+ Author: Stéphane Senart
27
+ Requires-Python: >=3.10
28
+ Classifier: Programming Language :: Python :: 3.10
29
+ Classifier: Programming Language :: Python :: 3.11
30
+ Classifier: Programming Language :: Python :: 3.12
31
+ Classifier: Programming Language :: Python :: 3.13
32
+ Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
33
+ Requires-Dist: pandas (>=2.1.4,<3.0.0)
34
+ Requires-Dist: requests (>=2.32.3,<3.0.0)
35
+ Description-Content-Type: text/markdown
36
+
37
+ # PyGazpar
38
+
39
+ PyGazpar is a Python library for getting natural gas consumption from GrDF French provider.
40
+
41
+ Their natural gas meter is called Gazpar. It is wireless and transmit the gas consumption once per day.
42
+
43
+ All consumption data is available on the client account at GrDF Web Site (https://monespace.grdf.fr).
44
+
45
+ PyGazpar automatically goes through the Web Site and download the consumption data, and make it available in a Python structure.
46
+
47
+ ## Installation
48
+
49
+ ### Requirements
50
+ PyGazpar does not require Selenium and corresponding geckodriver to work.
51
+
52
+ With the new GrDF web site, it is possible to load the consumption data far easily than before.
53
+
54
+ PyGazpar uses [Poetry](https://python-poetry.org/) for dependency and package management.
55
+
56
+ ### Create your virtual environment
57
+
58
+ ```bash
59
+ $ cd /path/to/my_project_folder/
60
+
61
+ $ poetry install
62
+ ```
63
+
64
+ ### PyGazpar installation
65
+
66
+ Use the package manager [pip](https://pip.pypa.io/en/stable/) to install PyGazpar.
67
+
68
+ ```bash
69
+ pip install pygazpar
70
+ ```
71
+
72
+ You can also download the source code and install it manually.
73
+ ```bash
74
+ cd /path/to/pygazpar/
75
+
76
+ $ poetry install
77
+ ```
78
+
79
+ ## Usage
80
+
81
+ #### Command line:
82
+
83
+ 1. Standard usage (using Json GrDF API).
84
+
85
+ ```bash
86
+ $ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' --datasource 'json'
87
+ ```
88
+
89
+ 2. Alternate usage (using Excel GrDF document).
90
+
91
+ ```bash
92
+ $ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' -t 'temporary directory where to store Excel file (ex: /tmp)' --datasource 'excel'
93
+ ```
94
+
95
+ 3. Test usage (using local static data files, do not connect to GrDF site).
96
+
97
+ ```bash
98
+ $ pygazpar -u 'your login' -p 'your password' -c 'your PCE identifier' --datasource 'test'
99
+ ```
100
+
101
+ #### Library:
102
+
103
+ 1. Standard usage (using Json GrDF API).
104
+
105
+ ```python
106
+ import pygazpar
107
+
108
+ client = pygazpar.Client(pygazpar.JsonWebDataSource(
109
+ username='your login',
110
+ password='your password')
111
+ )
112
+
113
+ # Returns the list of your PCE identifiers attached to your account.
114
+ pce_identifiers = client.get_pce_identifiers()
115
+
116
+ # Returns the daily and monthly consumptions for the last 60 days on your PCE identifier.
117
+ data = client.load_since(pce_identifier='your PCE identifier',
118
+ last_n_days=60,
119
+ frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
120
+ ```
121
+ See [samples/jsonSample.py](samples/jsonSample.py) file for the full example.
122
+
123
+ 2. Alternate usage (using Excel GrDF document).
124
+
125
+ ```python
126
+ import pygazpar
127
+
128
+ client = pygazpar.Client(pygazpar.ExcelWebDataSource(
129
+ username='your login',
130
+ password='your password')
131
+ )
132
+
133
+ # Returns the list of your PCE identifiers attached to your account.
134
+ pce_identifiers = client.get_pce_identifiers()
135
+
136
+ # Returns the daily and monthly consumptions for the last 60 days on your PCE identifier.
137
+ data = client.load_since(pce_identifier='your PCE identifier',
138
+ last_n_days=60,
139
+ frequencies=[pygazpar.Frequency.DAILY, pygazpar.Frequency.MONTHLY])
140
+ ```
141
+ See [samples/excelSample.py](samples/jsonSample.py) file for the full example.
142
+
143
+ 3. Test usage (using local static data files, do not connect to GrDF site).
144
+
145
+ ```python
146
+ import pygazpar
147
+
148
+ client = pygazpar.Client(pygazpar.TestDataSource())
149
+
150
+ data = client.load_since(pce_identifier='your PCE identifier',
151
+ last_n_days=10,
152
+ frequencies=[pygazpar.Frequency.DAILY, Frequency.MONTHLY])
153
+ ```
154
+ See [samples/testSample.py](samples/jsonSample.py) file for the full example.
155
+
156
+ #### Output:
157
+
158
+ ```json
159
+ data =>
160
+ {
161
+ "daily": [
162
+ {
163
+ "time_period": "13/10/2022",
164
+ "start_index_m3": 15724,
165
+ "end_index_m3": 15725,
166
+ "volume_m3": 2,
167
+ "energy_kwh": 17,
168
+ "converter_factor_kwh/m3": 11.16,
169
+ "temperature_degC": null,
170
+ "type": "Mesur\u00e9",
171
+ "timestamp": "2022-12-13T23:58:35.606763"
172
+ },
173
+ ...
174
+ {
175
+ "time_period": "11/12/2022",
176
+ "start_index_m3": 16081,
177
+ "end_index_m3": 16098,
178
+ "volume_m3": 18,
179
+ "energy_kwh": 201,
180
+ "converter_factor_kwh/m3": 11.27,
181
+ "temperature_degC": -1.47,
182
+ "type": "Mesur\u00e9",
183
+ "timestamp": "2022-12-13T23:58:35.606763"
184
+ }
185
+ ],
186
+ "monthly": [
187
+ {
188
+ "time_period": "Novembre 2022",
189
+ "start_index_m3": 15750,
190
+ "end_index_m3": 15950,
191
+ "volume_m3": 204,
192
+ "energy_kwh": 2227,
193
+ "timestamp": "2022-12-13T23:58:35.606763"
194
+ },
195
+ {
196
+ "time_period": "D\u00e9cembre 2022",
197
+ "start_index_m3": 15950,
198
+ "end_index_m3": 16098,
199
+ "volume_m3": 148,
200
+ "energy_kwh": 1664,
201
+ "timestamp": "2022-12-13T23:58:35.606763"
202
+ }
203
+ ]
204
+ }
205
+ ```
206
+
207
+ ## Limitation
208
+ PyGazpar relies on how GrDF Web Site is built.
209
+
210
+ Any change in the Web site may break this library.
211
+
212
+ We expect in close Future that GrDF makes available an open API from which we can get safely their data.
213
+
214
+ ## Contributing
215
+ Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
216
+
217
+ Please make sure to update tests as appropriate.
218
+
219
+ ## License
220
+ [MIT](https://choosealicense.com/licenses/mit/)
221
+
222
+ ## Project status
223
+ PyGazpar has been initiated for integration with [Home Assistant](https://www.home-assistant.io/).
224
+
225
+ Corresponding Home Assistant integration custom component is available [here](https://github.com/ssenart/home-assistant-gazpar).
@@ -0,0 +1,18 @@
1
+ pygazpar/__init__.py,sha256=lz_ZTlZlLQsSX0r81JkDAEWp9nWfGwPemMCTzdS-ar0,344
2
+ pygazpar/__main__.py,sha256=jPsyrQeDWCfpRRIn_yeV82jhmT-1ZOP9aVZHIqhpR8I,3220
3
+ pygazpar/api_client.py,sha256=9YTgcnDsGDr8Rv5sub4HAFcfDlTFIDfcSZ9UkMNqfkw,7808
4
+ pygazpar/client.py,sha256=CDKaWoXoHSdQ0QmuoWM-yyJaWs7tfZ9cZ0Cnap2FAyM,3569
5
+ pygazpar/datasource.py,sha256=qQuMPB0ifI_TGXmiSE9AXklEEQnPpBf2lxqKSrrnQwU,21192
6
+ pygazpar/enum.py,sha256=3ZCk4SziXF6pxgP3MuQ1qxYfqB3X5DOV8Rtd0GHsK9w,898
7
+ pygazpar/excelparser.py,sha256=YJrpaSL5mJQeTdfjdRzIOrTVtosOBK3cMfVK8nSlXk8,6233
8
+ pygazpar/jsonparser.py,sha256=GONNG1eWskw7XuYQenTa2TZ4NigoU8LOHDjVY-fWB-c,1973
9
+ pygazpar/resources/daily_data_sample.json,sha256=YJovtrNUMs257magTfyxiewLmecySFypcelbGFUUeT8,199583
10
+ pygazpar/resources/hourly_data_sample.json,sha256=N1F-Xz3GaBn2H1p7uKzhkhKCQV8QVR0t76XD6wmFtXA,3
11
+ pygazpar/resources/monthly_data_sample.json,sha256=yrr4SqrB2MubeVU2HX_FRDZKHIhC0LXCqkO1iqnFWcg,3351
12
+ pygazpar/resources/weekly_data_sample.json,sha256=AjNuZkZvdYUi-3A_Vho7MA50bUddVvvrZNXechodrAM,15587
13
+ pygazpar/resources/yearly_data_sample.json,sha256=-h0Oy-4yV6cfTaZ2oLjzEqPtoYxSyJ_48gQ92_rDWcw,446
14
+ pygazpar/version.py,sha256=y7qXgBBbnxrWN-de04Csq4SiWLqzQBkxux_ScYpNfug,83
15
+ pygazpar-1.3.0.dist-info/LICENSE,sha256=6dtw1Dy7oQSsLgJsLXI99HychyH0Ml45-JuyidjmiHc,1094
16
+ pygazpar-1.3.0.dist-info/METADATA,sha256=AoupL-gJDIyqRgD28DkKqI6S7vpzXqCANX26XJy4B-Y,7105
17
+ pygazpar-1.3.0.dist-info/WHEEL,sha256=7dDg4QLnNKTvwIDR9Ac8jJaAmBC_owJrckbC0jjThyA,88
18
+ pygazpar-1.3.0.dist-info/RECORD,,
@@ -1,5 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: bdist_wheel (0.36.2)
2
+ Generator: poetry-core 2.1.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
-
@@ -1,125 +0,0 @@
1
- import os
2
- import logging
3
- from selenium import webdriver
4
- from .webelementwrapper import WebElementWrapper
5
-
6
- # ------------------------------------------------------------------------------------------------------------
7
- class WebDriverWrapper:
8
-
9
- logger = logging.getLogger(__name__)
10
-
11
- # ------------------------------------------------------
12
- def __init__(self, firefox_webdriver_executable: str, wait_time: int, tmp_directory: str):
13
-
14
- self.__firefox_webdriver_executable = firefox_webdriver_executable
15
- self.__wait_time = wait_time
16
- self.__tmp_directory = tmp_directory
17
-
18
- # We remove the geckodriver log file
19
- geckodriverLogFile = f"{self.__tmp_directory}/pygazpar_geckodriver.log"
20
- if os.path.isfile(geckodriverLogFile):
21
- os.remove(geckodriverLogFile)
22
-
23
- # Initialize the Firefox WebDriver
24
- options = webdriver.FirefoxOptions()
25
- #options.log.level = 'trace'
26
- options.headless = True
27
- profile = webdriver.FirefoxProfile()
28
- profile.set_preference('browser.download.folderList', 2) # custom location
29
- profile.set_preference('browser.download.manager.showWhenStarting', False)
30
- profile.set_preference('browser.helperApps.alwaysAsk.force', False)
31
- profile.set_preference('browser.download.dir', self.__tmp_directory)
32
- profile.set_preference('browser.helperApps.neverAsk.saveToDisk', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
33
-
34
- self.__driver = webdriver.Firefox(executable_path=self.__firefox_webdriver_executable, firefox_profile=profile, options=options, service_log_path=geckodriverLogFile)
35
-
36
- self.__driver.set_window_position(0, 0)
37
- self.__driver.set_window_size(1920, 1200)
38
- #self.__driver.fullscreen_window()
39
-
40
- self.__driver.implicitly_wait(self.__wait_time)
41
-
42
-
43
- # ------------------------------------------------------
44
- def quit(self):
45
-
46
- WebDriverWrapper.logger.debug(f"quit()...")
47
- try:
48
- self.__driver.quit()
49
- WebDriverWrapper.logger.debug(f"quit() -> Ok")
50
- except Exception:
51
- WebDriverWrapper.logger.warning(f"quit() -> Error", exc_info=True)
52
- self.__driver.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
53
- raise
54
-
55
-
56
- # ------------------------------------------------------
57
- def get(self, url: str, description: str):
58
-
59
- WebDriverWrapper.logger.debug(f"get('{url}'): {description}...")
60
- try:
61
- res = self.__driver.get(url)
62
- WebDriverWrapper.logger.debug(f"get('{url}'): {description} -> Ok")
63
- return res
64
- except Exception:
65
- WebDriverWrapper.logger.warning(f"get('{url}'): {description} -> Error", exc_info=True)
66
- self.__driver.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
67
- raise
68
-
69
-
70
- # ------------------------------------------------------
71
- def current_url(self):
72
-
73
- WebDriverWrapper.logger.debug(f"current_url()...")
74
- try:
75
- self.__driver.current_url()
76
- WebDriverWrapper.logger.debug(f"current_url() -> Ok")
77
- except Exception:
78
- WebDriverWrapper.logger.warning(f"current_url() -> Error", exc_info=True)
79
- self.__driver.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
80
- raise
81
-
82
-
83
- # ------------------------------------------------------
84
- def find_element_by_id(self, id: str, description: str, screenshotOnNotFound: bool = True) -> WebElementWrapper:
85
-
86
- WebDriverWrapper.logger.debug(f"find_element_by_id('{id}'): {description}...")
87
- try:
88
- element = self.__driver.find_element_by_id(id)
89
- res = WebElementWrapper(element, description, self.__tmp_directory)
90
- WebDriverWrapper.logger.debug(f"find_element_by_id('{id}'): {description} -> Ok")
91
- return res
92
- except Exception:
93
- WebDriverWrapper.logger.warning(f"find_element_by_id('{id}'): {description} -> Not found", exc_info=False)
94
- if screenshotOnNotFound:
95
- self.__driver.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
96
- raise
97
-
98
-
99
- # ------------------------------------------------------
100
- def find_element_by_xpath(self, xpath: str, description: str, screenshotOnNotFound: bool = True) -> WebElementWrapper:
101
-
102
- WebDriverWrapper.logger.debug(f"find_element_by_xpath('{xpath}'): {description}...")
103
- try:
104
- element = self.__driver.find_element_by_xpath(xpath)
105
- res = WebElementWrapper(element, description, self.__tmp_directory)
106
- WebDriverWrapper.logger.debug(f"find_element_by_xpath('{xpath}'): {description} -> Ok")
107
- return res
108
- except Exception:
109
- WebDriverWrapper.logger.warning(f"find_element_by_xpath('{xpath}'): {description} -> Not found", exc_info=False)
110
- if screenshotOnNotFound:
111
- self.__driver.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
112
- raise
113
-
114
-
115
- # ------------------------------------------------------
116
- def save_screenshot(self, filename: str):
117
-
118
- WebDriverWrapper.logger.debug(f"save_screenshot('{filename}')...")
119
- try:
120
- res = self.__driver.save_screenshot(filename)
121
- WebDriverWrapper.logger.debug(f"save_screenshot('{filename}') -> Ok")
122
- return res
123
- except Exception:
124
- WebDriverWrapper.logger.warning(f"save_screenshot('{filename}') -> Error", exc_info=True)
125
-
@@ -1,40 +0,0 @@
1
- import logging
2
- from selenium.webdriver.remote.webelement import WebElement
3
-
4
- # ------------------------------------------------------------------------------------------------------------
5
- class WebElementWrapper:
6
-
7
- logger = logging.getLogger(__name__)
8
-
9
- # ------------------------------------------------------
10
- def __init__(self, element: WebElement, description: str, tmp_directory: str):
11
-
12
- self.__element = element
13
- self.__description = description
14
- self.__tmp_directory = tmp_directory
15
-
16
-
17
- # ------------------------------------------------------
18
- def click(self):
19
-
20
- WebElementWrapper.logger.debug(f"click(): {self.__description}...")
21
- try:
22
- self.__element.click()
23
- WebElementWrapper.logger.debug(f"click() -> Ok")
24
- except Exception:
25
- WebElementWrapper.logger.warning(f"click(): {self.__description} -> Error", exc_info=True)
26
- self.__element.parent.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
27
- raise
28
-
29
-
30
- # ------------------------------------------------------
31
- def send_keys(self, value: str):
32
-
33
- WebElementWrapper.logger.debug(f"send_keys({value}): {self.__description}...")
34
- try:
35
- self.__element.send_keys(value)
36
- WebElementWrapper.logger.debug(f"send_keys({value}) -> Ok")
37
- except Exception:
38
- WebElementWrapper.logger.warning(f"send_keys({value}): {self.__description} -> Error", exc_info=True)
39
- self.__element.parent.save_screenshot(f"{self.__tmp_directory}/error_screenshot.png")
40
- raise
@@ -1,149 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: pygazpar
3
- Version: 0.1.21
4
- Summary: Retrieve gas consumption from GrDF web site (French Gas Company)
5
- Home-page: https://github.com/ssenart/PyGazpar
6
- Author: Stephane Senart
7
- Author-email: stephane.senart@gmail.com
8
- License: MIT
9
- Download-URL: https://github.com/ssenart/pygazpar/releases/tag/0.1.21
10
- Keywords: Energy,Natural Gas,Consumption,GrDF,Gazpar
11
- Platform: UNKNOWN
12
- Classifier: Development Status :: 3 - Alpha
13
- Classifier: Topic :: Software Development :: Build Tools
14
- Classifier: License :: OSI Approved :: MIT License
15
- Classifier: Operating System :: OS Independent
16
- Classifier: Programming Language :: Python :: 3.7
17
- Requires-Python: >=3.7
18
- Description-Content-Type: text/markdown
19
- Requires-Dist: selenium (==3.141)
20
- Requires-Dist: openpyxl (==2.6.3)
21
-
22
- # PyGazpar
23
- PyGazpar is a Python library for getting natural gas consumption from GrDF French provider.
24
-
25
- Their natural gas meter is called Gazpar. It is wireless and transmit the gas consumption once per day.
26
-
27
- All consumption data is available on the client account at GrDF Web Site (https://monespace.grdf.fr).
28
-
29
- PyGazpar automatically go through the Web Site and download the consumption data Excel file, and make it available in a Python structure (list of dictionaries).
30
-
31
- ## Installation
32
-
33
- ### Requirements
34
- PyGazpar 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.
35
-
36
- PyGazpar has been developped and tested with Firefox browser (version 68.8) and its corresponding Web Driver geckodriver (version 0.24).
37
-
38
- #### Firefox browser installation
39
- Follow instructions [here](https://www.mozilla.org/fr/firefox/new)
40
-
41
- #### Firefox Web Driver (geckodriver) installation
42
- Follow instructions [here](https://github.com/mozilla/geckodriver/releases)
43
-
44
- ### Create your virtual environment
45
- ```bash
46
- $ pip install virtualenv
47
-
48
- $ cd /path/to/my_project_folder/
49
-
50
- $ virtualenv venv
51
- ```
52
-
53
- ### PyGazpar installation
54
- Use the package manager [pip](https://pip.pypa.io/en/stable/) to install PyGazpar.
55
-
56
- ```bash
57
- pip install pygazpar
58
- ```
59
-
60
- You can also download the source code and install it manually.
61
-
62
- ```bash
63
- cd /path/to/pygazpar/
64
- python setup.py install
65
- ```
66
-
67
- ## Usage
68
-
69
- ### Command line
70
-
71
- ```bash
72
- $ 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)'
73
- ```
74
-
75
- ### Library
76
-
77
- ```python
78
- import pygazpar
79
-
80
- client = pygazpar.Client('your login',
81
- 'your password',
82
- 'path/to/Selenium Web Driver',
83
- 30,
84
- 'temporary directory where to store XSLX file (ex: /tmp)')
85
-
86
- client.update()
87
-
88
- data = client.data()
89
- ```
90
-
91
- ### Output
92
-
93
- ```json
94
- data =>
95
- [
96
- {
97
- "date": "01/07/2019",
98
- "start_index_m3": 9802.0,
99
- "end_index_m3": 9805.0,
100
- "volume_m3": 3.6,
101
- "energy_kwh": 40.0,
102
- "converter_factor": "11,244",
103
- "local_temperature": "",
104
- "type": "MES",
105
- "timestamp": "2019-08-29T16:56:07.380422"
106
- },
107
- {
108
- "date": "02/07/2019",
109
- "start_index_m3": 9805.0,
110
- "end_index_m3": 9808.0,
111
- "volume_m3": 2.8,
112
- "energy_kwh": 31.0,
113
- "converter_factor": "11,244",
114
- "local_temperature": "21",
115
- "type": "MES",
116
- "timestamp": "2019-08-29T16:56:07.380422"
117
- },
118
- {
119
- "date": "03/07/2019",
120
- "start_index_m3": 9808.0,
121
- "end_index_m3": 9811.0,
122
- "volume_m3": 2.9,
123
- "energy_kwh": 33.0,
124
- "converter_factor": "11,244",
125
- "local_temperature": "",
126
- "type": "MES",
127
- "timestamp": "2019-08-29T16:56:07.380422"
128
- }
129
- ]
130
- ```
131
-
132
- ## Limitation
133
- PyGazpar relies on how GrDF Web Site is built. It goes through each Web pages and automatically fill forms, click buttons using their internal identifiers.
134
-
135
- Any change in the Web site structure or identifier naming may break this library.
136
-
137
- We expect in close Future that GrDF makes available a standard API from which we can get safely their data.
138
-
139
- ## Contributing
140
- Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
141
-
142
- Please make sure to update tests as appropriate.
143
-
144
- ## License
145
- [MIT](https://choosealicense.com/licenses/mit/)
146
-
147
- ## Project status
148
- PyGazpar has been initiated for integration with [Home Assistant](https://www.home-assistant.io/).
149
-
@@ -1,14 +0,0 @@
1
- pygazpar/__init__.py,sha256=RKhEDN5euu4BbAOqzyeiQZLUkHSsoBk5n9QUDDkQHyQ,117
2
- pygazpar/__main__.py,sha256=00bphprgyfRf876sYx3qtzI4apY1dMUs77ZhFKu7j2Y,2113
3
- pygazpar/client.py,sha256=a2UTxDFHj_EsBBQ8q6nmbCPRrMKjhTmy5NiZ1E8Qfkk,9577
4
- pygazpar/enum.py,sha256=0xGz4mF2Pl69bQfHjFMEEt2v4EkBJf8t9-1wigXV1VA,333
5
- pygazpar/webdriverwrapper.py,sha256=ZH1yvXTS_zFcmB-1X1U25p4KI9JuMSW1V3-mVAIf144,5569
6
- pygazpar/webelementwrapper.py,sha256=5Xy1cx5NjNeeugEmxDXOkw-x6L36c7o0rwXh4IUI6rA,1609
7
- test/__init__.py,sha256=lnB6CW_tnw1n4rdcjuebVcQ09mrkKu4pG_11JaRyQcg,34
8
- test/test_client.py,sha256=qOlIkPVUsYpKncoKSc2bDRTPqYnw4Ja4dJtHjWpKNms,1646
9
- pygazpar-0.1.21.dist-info/LICENSE.txt,sha256=XsCJx_7_BC9tvmE0ZxS1cTNR7ekurog_ea9ybdZ-8tc,1073
10
- pygazpar-0.1.21.dist-info/METADATA,sha256=SASgbZKGhhhbCXsIPzlDFLXsWMwY4mZmgtCZ2jmg1ps,4367
11
- pygazpar-0.1.21.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
12
- pygazpar-0.1.21.dist-info/entry_points.txt,sha256=c_FMZPYlRv1w9EqfgWhlkdJOoje7FcglI0UMm2oRLoI,53
13
- pygazpar-0.1.21.dist-info/top_level.txt,sha256=IAEv0wRUdR1eygoQs2efTQ0yUHt9wL-3qOeoHpHnA9Q,14
14
- pygazpar-0.1.21.dist-info/RECORD,,
@@ -1,3 +0,0 @@
1
- [console_scripts]
2
- pygazpar = pygazpar.__main__:main
3
-
@@ -1,2 +0,0 @@
1
- pygazpar
2
- test
test/__init__.py DELETED
@@ -1 +0,0 @@
1
- from pygazpar.client import Client
test/test_client.py DELETED
@@ -1,50 +0,0 @@
1
- import unittest
2
-
3
- from pygazpar.client import Client
4
-
5
- class ClientTestCase(unittest.TestCase):
6
-
7
- username = ""
8
- password = ""
9
- webdriver = ""
10
- wait_time = 30
11
- tmp_directory = ""
12
-
13
- def test_client(self):
14
- client = Client(self.username, self.password, self.webdriver, self.wait_time, self.tmp_directory)
15
- client.update()
16
-
17
- assert len(client.data()) != 0
18
-
19
- if __name__ == "__main__":
20
-
21
- from argparse import ArgumentParser
22
- parser = ArgumentParser()
23
- parser.add_argument("-u", "--username",
24
- required=True,
25
- help="GRDF username (email)")
26
- parser.add_argument("-p", "--password",
27
- required=True,
28
- help="GRDF password")
29
- parser.add_argument("-w", "--webdriver",
30
- required=True,
31
- help="Firefox webdriver executable (geckodriver)")
32
- parser.add_argument("-s", "--wait_time",
33
- required=False,
34
- type=int,
35
- default=30,
36
- help="Wait time in seconds (see https://selenium-python.readthedocs.io/waits.html for details)")
37
- parser.add_argument("-t", "--tmpdir",
38
- required=False,
39
- default="/tmp",
40
- help="tmp directory (default is /tmp)")
41
-
42
- args = parser.parse_args()
43
-
44
- ClientTestCase.username = args.username
45
- ClientTestCase.password = args.password
46
- ClientTestCase.webdriver = args.webdriver
47
- ClientTestCase.wait_time = args.wait_time
48
- ClientTestCase.tmp_directory = args.tmpdir
49
-
50
- unittest.main()