Initial commit

Author: roedesh

.editorconfig

@@ -0,0 +1,9 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -0,0 +1,16 @@
+# Byte-compiled / optimized / DLL files
+.pytest_cache/
+__pycache__/
+*$py.class
+
+# Distribution / packaging
+*.egg-info/
+build/
+dist/
+
+# OS generated files
+.idea
+
+# Unit test / coverage reports
+htmlcov/
+.coverage

.travis.yml

@@ -0,0 +1,13 @@
+language: python
+python:
+  - "3.4"
+  - "3.5"
+  - "3.6"
+install:
+  - 'pip install pipenv'
+  - 'pipenv sync'
+  - 'pip install mock pytest pytest-mock pytest-cov coveralls'
+script:
+  - 'pipenv run pytest'
+after_success:
+  - 'coveralls'

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2018] [Ruud Schroën]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,6 @@
+init:
+    pip install pipenv
+    pipenv install --dev
+
+test:
+    pipenv run pytest

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+requests = "*"
+
+[dev-packages]
+mock = "*"
+pytest = "*"
+pytest-mock = "*"
+pytest-cov = "*"

Pipfile.lock

@@ -0,0 +1,50 @@
+# postcodeapi
+
+`postcodeapi` is a tiny Python wrapper around the Postcode API V2.
+
+## 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.