Skip to main content

A python library for downloading your historical data fromutilities that use Bidgely

Project description

Bidgely

A Python library for getting historical and forecasted usage/cost from utilities that use Bidgely such as Hydro Ottawa.

Supported utilities:

  • Hydro Ottawa

Possible Supports:

  • BC Hydro
  • NS Power
  • Hydro One
  • Public Service Electric and Gas (PSE&G)

More here

Support a new utility

To add support for a new utility that uses the Bidgely NA API (you can tell if the energy dashboard of your utility makes network requests to naapi-read.bidgely.com in the network tab of your browser's developer tools) add a file similar to hydroottawa.py

Name the file after the utility , e.g. hydroottawa.py for Hydro Ottawa or bchydro.py for BC Hydro.

Since this library is planned to be used by Home Assistant, then per https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md we cannot have a dependency on a headless browser and we can only parse HTML during login.

An exception is made for the authentication phase. An integration is allowed to extract fields from forms. To make it more robust, data should not be gathered by scraping individual fields but instead scrape all fields at once.

Example

See demo.py

Thank you

Inspired by opower by @tronikos

Async pycognito sign in from @dotKrad

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bidgely-0.1.5.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

bidgely-0.1.5-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file bidgely-0.1.5.tar.gz.

File metadata

  • Download URL: bidgely-0.1.5.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/5.15.0-1041-azure

File hashes

Hashes for bidgely-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1b08b0d110631d2956758427205d3dc3ed3670f9f5904b54e78074bee80ec5fa
MD5 7789e4a9abad56ec36b2dc067fb15b67
BLAKE2b-256 739079a55c0030ba1f956a7a9a08d640729a736f7a5ee137163660b1826a2c1f

See more details on using hashes here.

File details

Details for the file bidgely-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: bidgely-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/5.15.0-1041-azure

File hashes

Hashes for bidgely-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f0a6272b7a452baa18221805db746203dc8e8fec803f6188d8666d01426588a0
MD5 3a6f910b19703b7cf1af52d32599f7d8
BLAKE2b-256 e9b69eec5c3d01da35ba9ff5bd13c72d4ad76de0a6acaa080714136d7bf9f754

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page