Metadata-Version: 2.1
Name: postcode-validator-uk
Version: 0.0.2
Summary: A simple UK postcode validator.
Home-page: https://github.com/guimunarolo/postcode-validator-uk
Author: Guilherme Munarolo
Author-email: guimunarolo@hotmail.com
License: MIT
Description: # postcode-validator-uk
        
        [![Python](https://img.shields.io/pypi/pyversions/postcode-validator-uk)](https://www.python.org/downloads/release/python-3/)
        [![CircleCI](https://circleci.com/gh/guimunarolo/postcode-validator-uk.svg?style=shield)](https://circleci.com/gh/guimunarolo/postcode-validator-uk)
        [![codecov](https://codecov.io/gh/guimunarolo/postcode-validator-uk/branch/master/graph/badge.svg)](https://codecov.io/gh/guimunarolo/postcode-validator-uk)
        
        A simple UK postcode validator.
        
        > Implemented following these instructions: [Wikipedia - Postcodes in the United Kingdom](https://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom#Formatting).
        
        
        ## Install
        
        postcode-validator-uk is available on PyPI:
        
        ```bash
        $ pip install postcode-validator-uk
        ```
        
        
        ## Usage
        
        ```python
        from postcode_validator_uk.validators import UKPostcode
        
        postcode = UKPostcode('ec1a 1bb')
        postcode.validate()
        
        postcode.validated_postcode
        # output
        'EC1A 1BB'
        
        postcode.raw_postcode
        # output
        'ec1a 1bb'
        
        postcode.outward
        # output
        'EC1A'
        
        postcode.inward
        # output
        '1BB'
        
        postcode.area
        # output
        'EC'
        
        postcode.district
        # output
        '1A'
        
        postcode.sector
        # output
        '1'
        
        postcode.unit
        # output
        'BB'
        ```
        
        
        ## Running tests
        
        ```bash
        $ pipenv install --dev
        $ make test
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3
Description-Content-Type: text/markdown
