Metadata-Version: 2.1
Name: pyveoliaidf
Version: 0.1.13
Summary: Retrieve water consumption from Veolia Ile-de-France web site (French Water Company)
Home-page: https://github.com/ssenart/pyveoliaidf
Author: Stephane Senart
Author-email: stephane.senart@gmail.com
License: MIT
Download-URL: https://github.com/ssenart/pyveoliaidf/releases
Project-URL: Home, https://github.com/ssenart/pyveoliaidf
Project-URL: Source, https://github.com/ssenart/pyveoliaidf
Project-URL: Issues, https://github.com/ssenart/pyveoliaidf/issues
Project-URL: Changelog, https://github.com/ssenart/pyveoliaidf/blob/master/CHANGELOG.md
Project-URL: Download, https://pypi.org/project/pyveoliaidf
Description: # PyVeoliaIDF
        PyVeoliaIDF is a Python library for getting water consumption from Veolia French provider.
        
        Their water meter are wireless and transmit the consumption once per day.
        
        All consumption data is available on the client account at Veolia Web Site (https://espace-client.vedif.eau.veolia.fr).
        
        PyVeoliaIDF automatically go through the Web Site and download the consumption data CSV file, and make it available in a Python structure (list of dictionaries).
        
        ## Installation
        
        ### Requirements
        PyVeoliaIDF is working with Selenium Python library to automate navigation through Veolia Web site. Selenium requires a WebDriver that acts as gateway between automatic actions from PyVeoliaIDF and a native browser already installed on the system.
        
        PyVeoliaIDF has been developped and tested with Firefox browser (version 68.8) and its corresponding Web Driver geckodriver (version 0.24).
        
        #### Firefox browser installation
        Follow instructions [here](https://www.mozilla.org/fr/firefox/new)
        
        #### Firefox Web Driver (geckodriver) installation
        Follow instructions [here](https://github.com/mozilla/geckodriver/releases)
        
        ### Create your virtual environment
        ```bash
        $ pip install virtualenv
        
        $ cd /path/to/my_project_folder/
        
        $ virtualenv venv
        ```
        
        ### PyVeoliaIDF installation
        Use the package manager [pip](https://pip.pypa.io/en/stable/) to install PyVeoliaIDF.
        
        ```bash
        pip install pyveoliaidf
        ```
        
        You can also download the source code and install it manually.
        
        ```bash
        cd /path/to/pyveoliaidf/
        python setup.py install
        ```
        
        ## Usage
        
        ### Command line
        
        ```bash
        $ pyveoliaidf -u 'your login' -p 'your password' -w 'path/to/Selenium Web Driver' -s 30 -t 'temporary directory where to store CSV file (ex: /tmp)'
        ```
        
        ### Library
        
        ```python
        import pyveoliaidf
        
        client = pyveoliaidf.Client('your login',
                                 'your password',
                                 'path/to/Selenium Web Driver',
                                 30,
                                 'temporary directory where to store CSV file (ex: /tmp)')
        
        client.update()
        
        data = client.data()
        ```
        
        ### Output
        
        ```json
        data =>
        [
          {
            "time": "2019-07-14 19:00:00",
            "total_liter": "506669",
            "daily_liter": "530",
            "type": "Estim\u00c3\u00a9",
            "timestamp": "2019-08-31T16:55:01.236779"
          },
          {
            "time": "2019-07-15 19:00:00",
            "total_liter": "507523",
            "daily_liter": "854",
            "type": "Mesur\u00c3\u00a9",
            "timestamp": "2019-08-31T16:55:01.236779"
          },
          {
            "time": "2019-07-16 19:00:00",
            "total_liter": "508314",
            "daily_liter": "791",
            "type": "Mesur\u00c3\u00a9",
            "timestamp": "2019-08-31T16:55:01.236779"
          }
        ]
        ```
        
        ## Limitation
        PyVeoliaIDF relies on how Veolia Web Site is built. It goes through each Web pages and automatically fill forms, click buttons using their internal identifiers.
        
        Any change in the Web site structure or identifier naming may break this library.
        
        We expect in close Future that Veolia makes available a standard API from which we can get safely their data.
        
        ## Contributing
        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.
        
        ## License
        [MIT](https://choosealicense.com/licenses/mit/)
        
        ## Project status
        PyVeoliaIDF has been initiated for integration with [Home Assistant](https://www.home-assistant.io/).
        
        # Changelog
        All notable changes to this project will be documented in this file.
        
        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
        
        ## [0.1.13] - 2021-12-03
        ### Fixed
        - Increase waiting time after selection of 'Jours' and 'Litres' buttons. Sometimes, we get only a partial set of data with missing most recent ones.
        
        ## [0.1.12] - 2020-10-12
        ### Fixed
        - The Veolia login email text box has changed its identifier.
        
        ## [0.1.11] - 2020-10-03
        ### Fixed
        - After simulating clicks on the 'Jours' and 'Litres' buttons, we have to wait a few (5 seconds) for internal form refresh. Otherwise, we got an inconsistent data file.
        
        ## [0.1.10] - 2020-10-03
        ### Fixed
        - The VeoliaIDF web site has changed and added some buttons to select the consumption period and the consumption unit.
        
        ## [0.1.9] - 2019-08-31
        ### Fixed
        - WebDriver window size must be large enough to display all clickable components.
        
        ## [0.1.8] - 2019-08-31
        ### Added
        - Use PropertyNameEnum type to store all property names.
        - Add LoginError exception raised when PyVeoliaIDF is unable to sign in the Veolia Web site with the given username/password.
        - Add timestamp property that contains date/time when the data has been retrieved.
        
        [0.1.12]: https://github.com/ssenart/PyVeoliaIDF/compare/0.1.11...0.1.12
        [0.1.11]: https://github.com/ssenart/PyVeoliaIDF/compare/0.1.10...0.1.11
        [0.1.10]: https://github.com/ssenart/PyVeoliaIDF/compare/0.1.9...0.1.10
        [0.1.9]: https://github.com/ssenart/PyVeoliaIDF/compare/0.1.8...0.1.9
        [0.1.8]: https://github.com/ssenart/PyVeoliaIDF/compare/0.1.7...0.1.8
        
Keywords: Resource,Water,Meter,Consumption,Veolia,Ile-de-France
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
