semvec/pypi-packages huggingface dataset:
django-postcode-lookup 1.0.1
Pluggable postcode lookup endpoint
License: MIT
Keywords: postcode,api,validation

======================
django-postcode-lookup
======================

This Django app providers a pluggable postcode django rest framework endpoint. It currently only works
for postcodes in The Netherlands.

Currently supports the following services:
 - ApiWise
 - Webservices.nl
 - postcodeapi.nu


Status
======
.. image:: https://travis-ci.org/LabD/django-postcode-lookup.svg?branch=master
    :target: https://travis-ci.org/LabD/django-postcode-lookup

.. image:: http://codecov.io/github/LabD/django-postcode-lookup/coverage.svg?branch=master 
    :target: http://codecov.io/github/LabD/django-postcode-lookup?branch=master
    
.. image:: https://img.shields.io/pypi/v/django-postcode-lookup.svg
    :target: https://pypi.python.org/pypi/django-postcode-lookup/

Installation
============

.. code-block:: shell

   pip install django_postcode_lookup
   
Usage
=====

Add the following to your urls.py:


.. code-block:: python

    path('postcode-lookup/', include('django_postcode_lookup.urls')),


Add a setting with the required backend

Webservices:

.. code-block:: python

    POSTCODE_LOOKUP = {
        'default': {
            'backend': 'django_postcode_lookup.backends.Webservices',
            'OPTIONS': {
                'username': 'someuser',
                'password': 'somepassword',
            }
        }
    }

ApiWise:

.. code-block:: python

    POSTCODE_LOOKUP = {
        'default': {
            'backend': 'django_postcode_lookup.backends.ApiWise',
            'OPTIONS': {
                'api_key': 'somekey',
            }
        }
    }

postcodeapi.nu:

.. code-block:: python

    POSTCODE_LOOKUP = {
        'default': {
            'backend': 'django_postcode_lookup.backends.PostcodeApiNu',
            'OPTIONS': {
                'api_key': 'somekey',
                'base_url': 'https://somebaseurl.com',
            }
        }
    }

To offer some form of protection to the api endpoint for usage by others a 
valid csrf token is required.