bchydro 0.7

BCHydro API

BCHydro API

BCHydro Python API for extracting electricity usage statistics from your personal account.

Installation

Via PyPi:

pip install bchydro

Via Github:

git clone https://github.com/emcniece/bchydro.git
cd bchydro
pip install -r requirements.txt

Usage

Running the example script:

pip install bchydro

export BCH_USER=[e-mail]
export BCH_PASS=your-bch-password

python test.py

Using in a project:

import asyncio
from bchydro import BCHydroApi

async def main():
    a = BCHydroApi()
    await a.authenticate("username", "password")

    usage = await a.get_usage(hourly=False)
    print(usage.electricity)
    print(a.get_latest_point())
    print(a.get_latest_usage())
    print(a.get_latest_cost())

asyncio.run(main())

BCHydro offers view-only accounts, as a more secure option.

Version Publishing

This repo is automatically published to PyPi by means of a Github Workflow when a new release is created on Github.

Todo

• Publish on release, not tag
• Handle account locking (looks for HTML alert dialogs)
• Unit tests

Disclaimer

This package has been developed without the express permission of BC Hydro. It accesses data by submitting forms that end-users would typically use in a browser. I'd love to work with BC Hydro to find a better way to access this data, perhaps through an official API... if you know anyone that works there, pass this along!