postalcodes_ni package

Submodules

postalcodes_ni.exceptions module

exception postalcodes_ni.exceptions.ISOCodeError

Bases: Exception

Thrown when ISO code doesnt exists

exception postalcodes_ni.exceptions.PostalCodeError

Bases: Exception

Thrown when postal code doesnt exists

postalcodes_ni.postalcodes module

postalcodes_ni.postalcodes.get_all_municipalities_by_iso(iso_code: str) → list

Returns all the municipalities for a department based on the ISO code

postalcodes_ni.postalcodes.get_all_municipalities_by_postal(postal_code: int) → list

Returns all the municipalities for a department based on the postal code

postalcodes_ni.postalcodes.get_municipality_by_name(name: str) → tuple

Returns a single record for a municipality based on the name

postalcodes_ni.postalcodes.get_municipality_by_postal(postal_code: int) → dict

Returns a single record for a municipality based on the postal code

Module contents

Top-level package for postalcodes-ni.

postalcodes_ni.get_all_municipalities_by_iso(iso_code: str) → list

Returns all the municipalities for a department based on the ISO code

postalcodes_ni.get_all_municipalities_by_postal(postal_code: int) → list

Returns all the municipalities for a department based on the postal code

postalcodes_ni.get_municipality_by_name(name: str) → tuple

Returns a single record for a municipality based on the name

postalcodes_ni.get_municipality_by_postal(postal_code: int) → dict

Returns a single record for a municipality based on the postal code