postcodes_io 0.1.0

Python client to connect to Postcodes.io API

Postcodes.io Python Client - alpha

Python client to connect to Postcodes.io API

• Free software: MIT license

• Documentation: https://postcodes-io.readthedocs.io.

Features

• Supports python 3.x (not yet python 2.x, sorry!)

• Response in Python native list and dict types

• Supports free http://postcodes.io/postcodes REST service and self-hosted service (See documentation for installation details)

Quick Start

Install python package:

$ pip install postcodes_io
$ python

from postcodes_io import Postcodes
pio = Postcodes()
postcode = pio.get('SW1A 1AA')

Self-hosted Service using Docker

1. Pull docker image:

   docker pull randomvariable/docker-postcodes.io

2. Run docker container as a daemon:

   docker run -p 8000:8000 -d randomvariable/docker-postcodes.io

3. Execute API using hosts

from postcodes_io import Postcodes
postcode = Postcodes('http://localhost:8000').get('SW1A 1AA')

TODOs

• Add more endpoints

• Documentation

• Proper isolated unit tests

History

0.1.0 (2016-07-08)

• First release on PyPI.