octopus-pull (1.0.0)

Published 2024-12-24 16:43:32 +00:00 by nigel

Installation

pip install --index-url  octopus-pull

About this package

Pull energy data from Octopus and save locally

Octopus Pull

Pull energy data from the Octopus API and save as JSON files locally.

Usage

usage:

octopus_pull [-h] [--version] [--debug] -a API_KEY --electricity_mpan ELECTRICITY_MPAN --electricity_meter ELECTRICITY_METER [--gas_mprn GAS_MPRN] [--gas_meter GAS_METER] [--days DAYS] [--output_directory OUTPUT_DIRECTORY]

Obtain Gas/Electric usage data from Octopus API.

options:

  • -h, --help -- show this help message and exit
  • --version -- show program's version number and exit
  • --debug -- Enable debug mode.
  • -a API_KEY, --api_key API_KEY -- The Octopus API key
  • --electricity_mpan ELECTRICITY_MPAN -- The MPAN for the Electricity service
  • --electricity_meter ELECTRICITY_METER -- The Electricity Meter Id
  • --gas_mprn GAS_MPRN -- The MPRN for the Gas service
  • --gas_meter GAS_METER -- The Gas Meter Id
  • --days DAYS -- Days of data to collect
  • --output_directory OUTPUT_DIRECTORY -- The base directory for output

Requirements

Requires Python: >=3.11,<4.0
Details
PyPI
2024-12-24 16:43:32 +00:00
0
Nigel Metheringham
8.5 KiB
Assets (2)
Versions (1) View all
1.0.0 2024-12-24