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.1.0.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

ENSEK-1.1.0-py2.py3-none-any.whl (3.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for ENSEK-1.1.0.tar.gz
Algorithm Hash digest
SHA256 d61380ba768e2ddeb09fba1d8e9ba26f91838a495c62c7db5667d8742926141e
MD5 d39b558643f36d518b58f9e676bcc002
BLAKE2b-256 7a7c8e65f5da41d8987fbb7555432a4988997b540981a17ee74ae762e08df190

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ENSEK-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5c801b7b5ed5d803cc051be14028f8db15c712790d0fbb601d6d8a0d74f23b4a
MD5 f7f15589bdd20bd5770506e97cf2574d
BLAKE2b-256 c872b9092454e1e279d91c9f0e4a9ef40e1c40531dd2b3fa7f22cf6d469ea289

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