Python client for the Octopus energy API
Project description
Octopy-Energy
Python client for the Octopus energy API
Installing Octopy-Energy
The first step to getting running with the library is to install it through pip.
! pip install octopyenergy
Requirement already satisfied: octopyenergy in c:\users\user\path\to\octopy-energy (0.0.1)
Once installed octopyenergy
can be imported into your scripts.
import octopyenergy as oe
from octopyenergy.api import DownloadManager
User Inputs
We now need to assign values for our account/meter details.
N.b. we recommend that you store your account details in a .env
file and then use the dotenv
library to set them as environment variables, which can in turn be picked up by os
and assigned to local variables.
octopus_api_key = 'your_octopus_api_key'
meter_mpan = 'your_meter_mpan'
meter_serial = 'your_meter_serial'
Configuring the Download Manager
We'll start by initialising the DownloadManager
, when we do so we can pass a number of parameters which will configure defaults in the download manager. The octopus_api_key
is also required for some requests.
download_manager = DownloadManager(meter_mpan=meter_mpan,
meter_serial=meter_serial,
api_key=octopus_api_key)
download_manager
Welcome to the octopyenergy DownloadManager! For more information please read the documentation at https://github.com/AyrtonB/Octopy-Energy.
The following API end-points are available:
retrieve_products, retrieve_product, retrieve_tariff_charges, retrieve_meter_point, retrieve_electricity_consumption, retrieve_gas_consumption, retrieve_gsps
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
Built Distribution
Hashes for octopyenergy-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4af2895fe5e5e4eae144452e0451fc20ccdf89011682a36450d1c8bef0e7ae5 |
|
MD5 | 2190575d0a265d8aaa9ff28f99f656a3 |
|
BLAKE2b-256 | 6b1a2d8e7e6dfaa996141f1a501f29010d9203ded8321ecf55cacf1c50affcdc |