Skip to content

david-lev/mikud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

8 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Alternative text

mikud: Search for Israeli zip code numbers

PyPI Downloads CodeFactor Docs

โ˜Ž๏ธ 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

๐Ÿ“– 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.

About

๐Ÿ“ฎ Search for Israeli zip code numbers

Topics

Resources

License

Stars

Watchers

Forks

Languages