Skip to content

Latest commit

 

History

History
109 lines (66 loc) · 2.02 KB

README.rst

File metadata and controls

109 lines (66 loc) · 2.02 KB
Raw

PyHydroQuebec

TODO

  • Add automated tests

Installation

pip install pyhydroquebec

Usage

Print your current data

pyhydroquebec -u MYACCOUNT -p MYPASSWORD

List your current contracts

pyhydroquebec -u MYACCOUNT -p MYPASSWORD -l

Print help

usage: pyhydroquebec [-h] [-u USERNAME] [-p PASSWORD] [-j] [-i] [-c CONTRACT]
                    [-l] [-H] [-t TIMEOUT] [-V] [--detailled-energy]
                    [--start-date START_DATE] [--end-date END_DATE]

optional arguments:
    -h, --help                          show this help message and exit
    -u USERNAME, --username USERNAME    Hydro Quebec username
    -p PASSWORD, --password PASSWORD    Password
    -j, --json                          Json output
    -i, --influxdb                      InfluxDb output
    -c CONTRACT, --contract CONTRACT    Contract number
    -l, --list-contracts                List all your contracts
    -H, --hourly                        Show yesterday hourly consumption
    -t TIMEOUT, --timeout TIMEOUT       Request timeout
    -V, --version                       Show version

Detailled-energy raw download option:
    --detailled-energy                  Get raw json output download
    --start-date START_DATE             Start date for detailled-output
    --end-date END_DATE                 End date for detailled-output

Docker

docker run -e PYHQ_USER=*** -e PYHQ_PASSWORD=*** ncareau/pyhydroquebec

Docker variables

PYHQ_USER - Required
-e PYHQ_USER=myusername
PYHQ_PASSWORD - Required
-e PYHQ_PASSWORD=mypassword

PYHQ_OUTPUT

  • -e PYHQ_OUTPUT=TEXT - Default
  • -e PYHQ_OUTPUT=JSON
  • -e PYHQ_OUTPUT=INFLUXDB
  • -e PYHQ_OUTPUT=CONTRACT

PYHQ_CONTRACT

-e PYHQ_CONTRACT=332211223

Dev env

make env

Run test

make test

Or

tox