Skip to main content

Get mikud (zip code in israel) by address.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mikud-0.0.3.tar.gz (6.4 kB view hashes)

Uploaded Source

Built Distribution

mikud-0.0.3-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page