Metadata-Version: 2.1
Name: octopus-energy
Version: 0.1.2
Summary: Python client for the Octopus Energy RESTful API
Home-page: https://github.com/markallanson/octopus-energy
License: MIT
Author: Mark Allanson
Author-email: mark@allanson.org
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aiohttp (>=3.7.1,<4.0.0)
Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
Description-Content-Type: text/markdown

# Octopus Energy Python API Client Library
A Client library for accessing the Octopus Energy APIs

***Warning: The API is currently undergoing active development and should be considered unstable,
even volatile until it reaches version 1.0.0***

[![PyPI version](https://badge.fury.io/py/octopus-energy.svg)](https://badge.fury.io/py/octopus-energy)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/octopus-energy)

[![Build Status](https://travis-ci.com/markallanson/octopus-energy.svg?branch=main)](https://travis-ci.com/markallanson/octopus-energy)
[![Coverage Status](https://coveralls.io/repos/github/markallanson/octopus-energy/badge.svg?branch=main)](https://coveralls.io/github/markallanson/octopus-energy?branch=main)

## Installation
`octopus-energy` can be installed from PyPI using pip:

```shell
pip install octopus-energy
```

## Code
The code is available in the [octopus-energy repository on GitHub][github]

## Features

* Get energy consumption from SMETS1 and SMETS2 electricity and gas meters.

## Quickstart
You can obtain your API token and meter information from the [Octopus Energy Developer 
Dashboard][octo dashboard].

```python
from octopus_energy import OctopusEnergyClient, MeterType

api_token="sk_live_your-token"
mprn = "your-mprn"
serial_number = "your-meter-serial-number"

client = OctopusEnergyClient(api_token)
consumption = await client.get_gas_consumption_v1(mprn, serial_number, MeterType.SMETS1_GAS)
```

[github]: https://github.com/markallanson/octopus-energy
[octo dashboard]: https://octopus.energy/dashboard/developer/

