Skip to main content

A tool for graphing data from the Octopus Energy API

Project description

Octopy Graph

A tool for graphing data from the Octopus Energy API

Getting Started

Installing

Either clone directly from the repo or install using pip

pip install octopy-graphs

Running

The tool is run using python3.7\6. For help text use:

python3.7 -m octopy_graph.__main__ -h

You will need the following information:

  • apikey - If you are an Octopus Energy customer, you can get an API key from your online dashboard.
  • gasserial - The gas meters serial number. Printed on your gas meter and on your bill. Looks like G3P69380371200.
  • mprn - The MPRN for your gas meter. On your bill as Meter Point Reference, looks like 3429439001.
  • electricserial - The electricity meters serial number. Printed on your meter and on your bill. Looks like 12P1022008.
  • mpan - The MPAN for you electricity meter. On your bill as Supply Number, looks like 2019820081223

Examples

The tool uses plotly to graph data. Here are some examples.

Daily

A graph showing gas and electricity usage on a specific date.

Weekly

A graph showing gas and electricity usage for a specific week.

Average Hourly

A graph showing the average energy usage at specific times during the day.

Average Daily

A graph showing the average energy usage on specific days of the week.

Average Weekly

A graph showing the average energy usage on weeks throughout the year.

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

octopy-graph-0.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

octopy_graph-0.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file octopy-graph-0.1.tar.gz.

File metadata

  • Download URL: octopy-graph-0.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for octopy-graph-0.1.tar.gz
Algorithm Hash digest
SHA256 fad4e3e571b374e9e35e3fe88affd81d37cae59505396684727b66e29c8b7ea4
MD5 d764a063783d02b53042d208d742f113
BLAKE2b-256 6c9d3078c64ec8bab337b3c713ff4e4ecef2498534942d20ccbefdebf480f857

See more details on using hashes here.

File details

Details for the file octopy_graph-0.1-py3-none-any.whl.

File metadata

  • Download URL: octopy_graph-0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.9

File hashes

Hashes for octopy_graph-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0e9fc9dba2e67e110e1cf9e5de5855f36f70c4f50033d1634034eaf5cd039276
MD5 a08a9b95512a00d1416ab35a424af095
BLAKE2b-256 ad179710e5003c41b279365eb2ca9133a8fb3cfb817d6a5587a3ed8c7470138f

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