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 or MPRN

client.get_account_for_meter_point(meter_point_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')

Get electricity utility information for a MPAN CORE ID (meter point administration number)

client.get_electricity_utility(mpan_core_id='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.2.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

ENSEK-1.2.0-py2.py3-none-any.whl (3.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for ENSEK-1.2.0.tar.gz
Algorithm Hash digest
SHA256 da942b948ae865d1590bc184c2dc94ca6aa09cc32926c5d6b8daac2f9c59f324
MD5 09705608f119c5d19df74c699fcca9e2
BLAKE2b-256 d5a2f240f2ade0fcdac761dbaf1fa78dc43cae0ee794bb5954de64d0c396cf1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ENSEK-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5a5d7aeacd0bf192a3f22558834a58ce92527d09aaa675eddbae0d6320e05bd2
MD5 f65925e97d6c4a2fe342305eaa836059
BLAKE2b-256 d6cb3634aeac43df1a7588e5666c01d2e6ec7749d265d0945d5163c41fdeaf03

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