postalcodes-nepal

A package for working with postal codes information of Nepal


Keywords
postalcodes, Nepal, zipcodes, postalcodes-nepal
License
MIT
Install
pip install postalcodes-nepal==1.0.0

Documentation

postalcodes-nepal

postalcodes-nepal is a python package that helps you to work with postal codes (Zip codes) of Nepal. Some of the functionality currently supported by postalcodes-nepal are:

  • Query for the postal code of any city of Nepal.
  • Check wheather a postal code is valid code of Nepal.
  • Find the post office information based on city or postal code.
  • Find postal codes of all post office within a district.
  • Find postal codes of all post office of Nepal

Installation

Run the following to install:

$ pip install postalcodes-nepal

Usage

Some simple usecases of postalcodes-nepal

from postalcodes_nepal.postalcodes import *

#Validate postal code. Checks if the postal code is valid and return True or False accordingly.
validate(44660)

#Find the postal code of particular city. Returns postal code or if the query didnot match any city returns None.
postal_code('Kathmandu')

#Returns the post office informtion of the city ie. District, Post Office, Postal Code and Post Office Type. Returns None if data doesnot match.
city_po_info('Kathmandu')

#Returns the city of the provided postal code. Returns None if data doesnot match.
postalcode_to_city(44600)

#Returns the post office information of the postal code.  Returns None if data doesnot match.
`postalcode_info(44600)

#Returns the city and postal codes of all post office of a district. Returns None if query doesnot match.
district_data('Jhapa')

#Returns the city and postal codes of all post offices of Nepal.
country_data()

OR you can alternatively import as follows:

from postalcodes_nepal import postalcodes

postalcodes.validate(44600)

#OR import individually
from postalcodes_nepal.postalcodes import validate

validate(44600)

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Links