A tiny wrapper around the Postcode API v2
Project description
# postcodeapi
`postcodeapi` is a tiny Python wrapper around the Postcode API V2.
[![Build Status](https://travis-ci.org/roedesh/postcodeapi.svg?branch=master)](https://travis-ci.org/roedesh/postcodeapi)
[![Coverage Status](https://coveralls.io/repos/github/roedesh/postcodeapi/badge.svg?branch=master)](https://coveralls.io/github/roedesh/postcodeapi?branch=master)
## Installation and usage
### Installation
*postcodeapi* can be installed by running `pip install postcodeapi`.
### Usage
Here is an example of how to use the API client. First you initialize a client with your API key, after that you use
one of the four getter methods to fetch the data you need. They all return the actual JSON response converted to a
Python dictionary.
```python
# Import the PostcodeAPIClient
from postcodeapi.client import PostcodeAPIClient
# Initialize a client with your API key
client = PostcodeAPIClient(api_key="YOUR_API_KEY")
# Fetch a list of addresses (for a given postal_code and number)
# The postal_code and number parameters are optional
# The number parameter only works together with postal_code
data = client.get_all_addresses(postal_code="5038EA", number=19)
addresses = data["_embedded"]["addresses"] # List of addresses
# Fetch a single address
address = client.get_address(address_id="0855200000046355")
# Fetch a list of postal codes (within a specific area)
# The area parameter is optional
data = client.get_all_postal_codes(area="5038")
postal_codes = data['_embedded']['postcodes'] # List of postal codes
# Fetch a single postal code
postal_code = client.get_postal_code("5038EA")
```
## Documentation
For more information about the data that is returned, please refer to the [official API documentation](https://www.postcodeapi.nu/docs/). It is written in Dutch.
## Running tests
To run the tests, make sure you have the dev dependencies installed, and run `pytest` in the root of the project.
## Issues
If you have any issues with the API wrapper, please post them [here](https://github.com/infoklik/postcodeapi/issues). If you have issues with the actual API,
please post them in the [official issue tracker](https://github.com/postcodeapi/postcodeapi/issues) of Postcode API.
`postcodeapi` is a tiny Python wrapper around the Postcode API V2.
[![Build Status](https://travis-ci.org/roedesh/postcodeapi.svg?branch=master)](https://travis-ci.org/roedesh/postcodeapi)
[![Coverage Status](https://coveralls.io/repos/github/roedesh/postcodeapi/badge.svg?branch=master)](https://coveralls.io/github/roedesh/postcodeapi?branch=master)
## Installation and usage
### Installation
*postcodeapi* can be installed by running `pip install postcodeapi`.
### Usage
Here is an example of how to use the API client. First you initialize a client with your API key, after that you use
one of the four getter methods to fetch the data you need. They all return the actual JSON response converted to a
Python dictionary.
```python
# Import the PostcodeAPIClient
from postcodeapi.client import PostcodeAPIClient
# Initialize a client with your API key
client = PostcodeAPIClient(api_key="YOUR_API_KEY")
# Fetch a list of addresses (for a given postal_code and number)
# The postal_code and number parameters are optional
# The number parameter only works together with postal_code
data = client.get_all_addresses(postal_code="5038EA", number=19)
addresses = data["_embedded"]["addresses"] # List of addresses
# Fetch a single address
address = client.get_address(address_id="0855200000046355")
# Fetch a list of postal codes (within a specific area)
# The area parameter is optional
data = client.get_all_postal_codes(area="5038")
postal_codes = data['_embedded']['postcodes'] # List of postal codes
# Fetch a single postal code
postal_code = client.get_postal_code("5038EA")
```
## Documentation
For more information about the data that is returned, please refer to the [official API documentation](https://www.postcodeapi.nu/docs/). It is written in Dutch.
## Running tests
To run the tests, make sure you have the dev dependencies installed, and run `pytest` in the root of the project.
## Issues
If you have any issues with the API wrapper, please post them [here](https://github.com/infoklik/postcodeapi/issues). If you have issues with the actual API,
please post them in the [official issue tracker](https://github.com/postcodeapi/postcodeapi/issues) of Postcode API.
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
postcodeapi-1.0.0.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for postcodeapi-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 603f52c48a7db4547b5f8a6466bf54e86d05d82cd3df643cbd8a75dd15c35496 |
|
MD5 | ffb8adf9d7d474f0aac45aedad2213b0 |
|
BLAKE2b-256 | 51f935ac953111775e9115d16be031ba1c01fce50aac964895326d9d24e9336f |