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](http://www.energybrokers.co.uk/electricity/PES-Distributor-areas.htm) for a postcode

client.get_region_id_for_postcode(postcode='se14yu')

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

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

Uploaded Source

Built Distribution

ENSEK-0.2.0-py2.py3-none-any.whl (3.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for ENSEK-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7332075940307c1f4f267f99950a1446079fd4b1df230b408fed6381aac61af0
MD5 d02ee08e82441dcb05dfd1cb9775e1f7
BLAKE2b-256 dfc34bf49af8ee693f6db17ec06d5abd7cbb8921997fc54860a2e8821ae49584

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ENSEK-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f82a38c57705db9076a5a429d41f3dfc1969e30d1dad49ea9319bf9d0210d3d6
MD5 91a8d1525dc2658d2a460e3052b3dc55
BLAKE2b-256 3e0c51343c7821ec423ec2cb52bc721b5ee1eb88d7e2178885d05fb4cc7fba8f

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