package supports validating and formatting postcodes for the UK
Project description
ideal_ukpostcode
package supports validating and formatting postcodes for the UK
- Free software: MIT license
- Documentation: https://myselfdesai.github.io/ideal_ukpostcode
- PyPI: https://pypi.python.org/pypi/ideal_ukpostcode
Introduction
package supports validating and formatting postcodes for the UK. The details of which postcodes are valid and which are the parts they consist of can be found at wiki
Installation
To install ideal_ukpostcode, run this command in your terminal:
pip install ideal_ukpostcode
This is the preferred method to install ideal_ukpostcode, as it will always install the most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
From sources
The sources for ideal_ukpostcode can be downloaded from the Github repo.
You can clone the public repository:
git clone git://github.com/myselfdesai/ideal_ukpostcode
Usage
To use ideal_ukpostcode in a project:
validate a postcode
it gives boolean result True or False
import ideal_ukpostcode
ideal_ukpostcode.validate("EC1A 1BB")
format a postcode
format(area, district, sector, unit)
import ideal_ukpostcode
ideal_ukpostcode.format("EC","1A","1","BB")
Test
install dev dependencies
pip install -r requirements_dev.txt
In the root folder, execute :
pytest
Credits
This package was created with Cookiecutter and the giswqs/pypackage project template.
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
Built Distribution
Hashes for ideal_ukpostcode-1.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2721857231de0a6b4b08ea354977597b148a0e3449b389ddeb0b79f37b7d605e |
|
MD5 | 87c3b7766d7e67c5c59b873094b63328 |
|
BLAKE2b-256 | e7f88ad22c6481c87065bd8f848b20c9c9e241e66d01c59bca317e2211be1dd9 |