Skip to main content

Python Client for the ENSEK API (http://www.ensek.co.uk/)

Project description

PyPI Python Versions Build Status

🐍 Python Client for the ENSEK API (http://www.ensek.co.uk/) This client does not implement all the features of the API, pull requests are very welcome to expand functionality.

Installation

To install ensek, simply:

pip install ensek

How To Use

Initialise the client

from ensek import Ensek
client = Ensek(
    api_url='https://api.usio.ignition.ensek.co.uk/',
    api_key='fill_this_in',
)

Available methods

Get an account by id

client.get_account(account_id=123)

Get tariffs for an account by id

client.get_account_tariffs(account_id=123)

Get meter points for an account by id

client.get_meter_points(account_id=123)

Get recent newly registered accounts

client.get_completed_signups()

Get the account id currently associated with an MPAN core id

client.get_account_for_meter_point(mpan_core_id='9910000001507')

Get the PES Area for a postcode (http://www.energybrokers.co.uk/electricity/PES-Distributor-areas.htm)

client.get_region_id_for_postcode(postcode='se14yu')

Get gas utility information for a MPRN (meter point reference number)

client.get_gas_utility(mprn='3226987202')

Note: For each client method:

  • If API response is 404, method will raise LookupError.

  • If API response is between 400 and 499, method will raise ValueError.

  • For any other bad status code EnsekError will raise.

Requirements

1. Python 3.6+
2. See requirements.txt

Running the tests

pip install -r requirements-test.txt
pytest

Releasing to PyPI

pip install zest.releaser
fullrelease

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

ENSEK-1.0.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

ENSEK-1.0.0-py2.py3-none-any.whl (3.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ENSEK-1.0.0.tar.gz.

File metadata

  • Download URL: ENSEK-1.0.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ENSEK-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9cb2886188db55fd1f28b5b880742842356b88887fa25433a2d1c36d57bea655
MD5 c63c05fac7252d1b5f76a570f9aab692
BLAKE2b-256 37169d3105b4b6c9c64caa0c6740ff17fd71ba5e460329a15d8ac331da6aab09

See more details on using hashes here.

File details

Details for the file ENSEK-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ENSEK-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e5af23f2456110547f137a0d768153bca874ff45dcc06e7353892501eb8a93be
MD5 d30fa7b8b0e7b2e6a598957077444330
BLAKE2b-256 9794b91fec92ddd113df6a18874129257dbab16f19fe302975282c42855c1dd7

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