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')

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

Uploaded Source

Built Distribution

ENSEK-0.1.0-py2.py3-none-any.whl (3.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for ENSEK-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7ecc02dda0fbc05b489d50921998e159519dd11ac6c44684b8e007a5b81d815f
MD5 a29e46156d503229feb7c6169d8b218d
BLAKE2b-256 afff1e7bcf1a9e5139c7301156b0a8ca2058e850734ddd02083f30772e383071

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ENSEK-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ad825266fd4a9c7676b6859c31532aedc9dc486e3161efaf7cb93764e25765cb
MD5 0ef32fe507ef3f9325c83a8a7e10fafc
BLAKE2b-256 2d72748f18385b64e5301fd7f1260645f7a487aa7f54ab9e0365186e7fe4637d

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