{
    "info": {
        "author": "Ruud Schro\u00ebn",
        "author_email": "schroenruud@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "postcodeapi\n===========\n\n``postcodeapi`` is an unofficial Python wrapper around the Postcode API\nV2.\n\n|PyPI version| |Build Status| |Requirements Status| |Coverage Status|\n\nInstallation and usage\n----------------------\n\nInstallation\n~~~~~~~~~~~~\n\n*postcodeapi* can be installed by running ``pip install postcodeapi``.\n\nUsage\n~~~~~\n\nHere is an example of how to use the API client. First you initialize a\nclient with your API key, after that you use one of the four getter\nmethods to fetch the data you need. They all return the actual JSON\nresponse converted to a Python dictionary.\n\n.. code:: python\n\n   # Import the PostcodeAPIClient\n   from postcodeapi.client import PostcodeAPIClient\n\n   # Initialize a client with your API key\n   client = PostcodeAPIClient(api_key=\"YOUR_API_KEY\")\n\n   # Fetch a list of addresses (for a given postal_code and number)\n   # The postal_code and number parameters are optional\n   # The number parameter only works together with postal_code\n   data = client.get_all_addresses(postal_code=\"5038EA\", number=19)\n   addresses = data[\"results\"] # List of addresses\n   next_id = data[\"next\"] # Next ID to search from (used for pagination)\n\n   # Fetch a single address\n   address = client.get_address(address_id=\"0855200000046355\")\n\n   # Fetch a list of postal codes (within a specific area)\n   # The area parameter is optional\n   data = client.get_all_postal_codes(area=\"5038\")\n   postal_codes = data[\"results\"] # List of postal codes\n   next_postal_code = data[\"next\"] # Next postal code to search from (used for pagination)\n\n   # Fetch a single postal code\n   postal_code = client.get_postal_code(\"5038EA\")\n\nExceptions\n~~~~~~~~~~\n\nThere are 5 exceptions that can occur:\n\n-  ``NoAccessException``, which occurs when the current account does not\n   have the required privileges to perform the action;\n-  ``ResourceNotFoundException``, which occurs when the returned\n   status_code is 404. Limited to the *get_address* and\n   *get_postal_code* methods;\n-  ``HouseNumberRequiresPostalCodeException``, which occurs when a\n   house_number is given but not a postal_code. Limited to the\n   *get_all_addresses* method;\n-  ``InvalidPostalCodeException``, which occurs when an invalid postal\n   code is given;\n-  ``LimitExceededException``, which occurs when there are too many\n   network requests or the limit has been exceeded\n\nDocumentation\n-------------\n\nFor more information about the data that is returned, please refer to\nthe `official API documentation`_. It is written in Dutch.\n\nRunning tests\n-------------\n\nTo run the tests, make sure you install the dev dependencies by running\n``pipenv install --dev``, and then run\n\n.. _official API documentation: https://www.postcodeapi.nu/docs/\n\n.. |PyPI version| image:: https://badge.fury.io/py/postcodeapi.svg\n   :target: https://badge.fury.io/py/postcodeapi\n.. |Build Status| image:: https://travis-ci.org/roedesh/postcodeapi.svg?branch=master\n   :target: https://travis-ci.org/roedesh/postcodeapi\n.. |Requirements Status| image:: https://requires.io/github/roedesh/postcodeapi/requirements.svg?branch=master\n   :target: https://requires.io/github/roedesh/postcodeapi/requirements/?branch=master\n.. |Coverage Status| image:: https://coveralls.io/repos/github/roedesh/postcodeapi/badge.svg?branch=master\n   :target: https://coveralls.io/github/roedesh/postcodeapi?branch=master\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/roedesh/postcodeapi",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "postcodeapi",
        "package_url": "https://pypi.org/project/postcodeapi/",
        "platform": "",
        "project_url": "https://pypi.org/project/postcodeapi/",
        "project_urls": {
            "Homepage": "http://github.com/roedesh/postcodeapi"
        },
        "release_url": "https://pypi.org/project/postcodeapi/1.2.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "An unofficial Python wrapper around the Postcode API v2",
        "version": "1.2.1"
    },
    "last_serial": 5170575,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ffb8adf9d7d474f0aac45aedad2213b0",
                    "sha256": "603f52c48a7db4547b5f8a6466bf54e86d05d82cd3df643cbd8a75dd15c35496"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ffb8adf9d7d474f0aac45aedad2213b0",
                "packagetype": "bdist_wheel",
                "python_version": "3.7",
                "requires_python": null,
                "size": 4458,
                "upload_time": "2018-10-14T14:47:54",
                "url": "https://files.pythonhosted.org/packages/51/f9/35ac953111775e9115d16be031ba1c01fce50aac964895326d9d24e9336f/postcodeapi-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3d0d0ae9649db0d6072a62c27753aa76",
                    "sha256": "b51c5ad6accbd81af88877426a3f6e8dcee4d093a82053938010c9c29cced6af"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "3d0d0ae9649db0d6072a62c27753aa76",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3503,
                "upload_time": "2018-10-14T14:47:43",
                "url": "https://files.pythonhosted.org/packages/28/1e/44dd34d9e986b451047354fe128eb18e445e22f8f8fa197cab41134918a1/postcodeapi-1.0.0.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d6771866140217dc273de00cd2e7bc6d",
                    "sha256": "6f7afeb346887fb5236f5da0cc5e8c8b54ee9d369594290e193c9ae8ddcfeb22"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d6771866140217dc273de00cd2e7bc6d",
                "packagetype": "bdist_wheel",
                "python_version": "3.7",
                "requires_python": null,
                "size": 4515,
                "upload_time": "2019-02-06T20:00:40",
                "url": "https://files.pythonhosted.org/packages/59/cf/d83601b8d8f4a45f83d6eea4eb153b7c4a58de1cecb9abd1bb1e6d316f3d/postcodeapi-1.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "5cc5e99d4cbd2df18d431d783c734b03",
                    "sha256": "c76cdaeb2cf2a9d2b0377d5889aef40c33801763d5c4e133e181ef6054aa2bb2"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "5cc5e99d4cbd2df18d431d783c734b03",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3559,
                "upload_time": "2019-02-06T20:00:24",
                "url": "https://files.pythonhosted.org/packages/03/89/047bb80e692f76b6230d6baead56fdd57c6597d3357dc7c33f829d54b5f6/postcodeapi-1.0.2.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0421a89312059bd90801aaa4beb46a8f",
                    "sha256": "f1d37ccac8854b7307202c34fa3a15703e362b987ff757001c5c30ca9f5e4142"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0421a89312059bd90801aaa4beb46a8f",
                "packagetype": "bdist_wheel",
                "python_version": "3.7",
                "requires_python": null,
                "size": 4928,
                "upload_time": "2019-04-12T23:19:16",
                "url": "https://files.pythonhosted.org/packages/f7/95/66f6f78243aed4338b207f8f7603eb9640c1e637e7e3d8ecb7337e15e6f4/postcodeapi-1.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "95d5d7f283b880f889af1fee9603ca39",
                    "sha256": "71585af45acad2c0e83047faea4f0cbaaf0aaee345986ec693f0cf7632b5e472"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "95d5d7f283b880f889af1fee9603ca39",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4353,
                "upload_time": "2019-04-12T23:19:04",
                "url": "https://files.pythonhosted.org/packages/9a/de/783e5f9236bb0c6b68b94426fddaf936e7638a8c238df9a04ba7ece8bdeb/postcodeapi-1.1.0.tar.gz"
            }
        ],
        "1.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fafb9e2150b538808d38b976a1eb3a10",
                    "sha256": "c55b199100f0dd4e572f309e215b2feb3351daf53eb125546e729fccf73916ab"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fafb9e2150b538808d38b976a1eb3a10",
                "packagetype": "bdist_wheel",
                "python_version": "3.7",
                "requires_python": null,
                "size": 5062,
                "upload_time": "2019-04-13T19:26:20",
                "url": "https://files.pythonhosted.org/packages/9c/48/a898b458bfb9b838ff8f04298921088e05fd990821770acc9d04f82dc432/postcodeapi-1.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c87d758ceb28ab69f2a419a064bd6a7d",
                    "sha256": "ba0be80a4254488219d05ead20edb1a6c6793d6d8da26c50c8191d854e050065"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "c87d758ceb28ab69f2a419a064bd6a7d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4657,
                "upload_time": "2019-04-13T19:26:09",
                "url": "https://files.pythonhosted.org/packages/c7/6d/7add6d10ef073d8283dd4e5e7d5a05b2f20b77be18978c4f862c0e48919c/postcodeapi-1.2.0.tar.gz"
            }
        ],
        "1.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3f629dd466a50760921d14a865d638ce",
                    "sha256": "eaedce8481c2373a8f4142b4fd96898933c5158c70496f68f30392493148ff0d"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.2.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3f629dd466a50760921d14a865d638ce",
                "packagetype": "bdist_wheel",
                "python_version": "3.7",
                "requires_python": null,
                "size": 5070,
                "upload_time": "2019-04-21T20:00:03",
                "url": "https://files.pythonhosted.org/packages/53/61/31bebf999737f7116b93e3df6e47e7d2d3221f45956f047dab5ade3b7871/postcodeapi-1.2.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0a859264018f65d287abc470b386c102",
                    "sha256": "e59a96d83b00b6987f6a64e32b0b95491723a0314632f9d3ee905a599aa4dca5"
                },
                "downloads": -1,
                "filename": "postcodeapi-1.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "0a859264018f65d287abc470b386c102",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4676,
                "upload_time": "2019-04-21T19:59:58",
                "url": "https://files.pythonhosted.org/packages/6d/1f/5a253589296796c84c6be2ff1dabcd6817cf6a8cdc58822a0517bd70ec77/postcodeapi-1.2.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3f629dd466a50760921d14a865d638ce",
                "sha256": "eaedce8481c2373a8f4142b4fd96898933c5158c70496f68f30392493148ff0d"
            },
            "downloads": -1,
            "filename": "postcodeapi-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3f629dd466a50760921d14a865d638ce",
            "packagetype": "bdist_wheel",
            "python_version": "3.7",
            "requires_python": null,
            "size": 5070,
            "upload_time": "2019-04-21T20:00:03",
            "url": "https://files.pythonhosted.org/packages/53/61/31bebf999737f7116b93e3df6e47e7d2d3221f45956f047dab5ade3b7871/postcodeapi-1.2.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0a859264018f65d287abc470b386c102",
                "sha256": "e59a96d83b00b6987f6a64e32b0b95491723a0314632f9d3ee905a599aa4dca5"
            },
            "downloads": -1,
            "filename": "postcodeapi-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0a859264018f65d287abc470b386c102",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4676,
            "upload_time": "2019-04-21T19:59:58",
            "url": "https://files.pythonhosted.org/packages/6d/1f/5a253589296796c84c6be2ff1dabcd6817cf6a8cdc58822a0517bd70ec77/postcodeapi-1.2.1.tar.gz"
        }
    ]
}