david-lev / mikud

📮 Search for Israeli zip code numbers

mikud: Search for Israeli zip code numbers

☎️ mikud is a Python3 library to search israel's zip codes (mikud) by their addresses.

📖 For a complete documentation of available functions, see the Reference.

>>️ This tool based on israelpost website - Click here.

🎛 Installation

• Install using pip3:

pip3 install -U mikud

• Install from source:

git clone https://github.com/david-lev/mikud.git
cd mikud && python3 setup.py install

🎉 Features

• Search zip code by address
• Search address by zip code
• Get cities
• Get streets

👨‍💻 Usage

from mikud import Mikud

mikud = Mikud()
mikud_res = mikud.search_mikud(city_name="ירושלים",
                               street_name="כנפי נשרים",
                               house_number="20")
print(mikud_res.zip)
#> 9546432

addr = mikud.search_address(zip_code=9546432)
print(addr.city_name, addr.street_name, addr.house_number)
#> ירושלים כנפי נשרים 20

💾 Requirements

• Python 3.6 or higher - https://www.python.org

📖 Setup and Usage

See the Documentation for detailed instructions

⛔ Disclaimer

This application is intended for educational purposes only. Any use in professional manner or to harm anyone or any organization doesn't relate to me and can be considered as illegal.