https://github.com/david-lev/mikud

📮 Search for Israeli zip code numbers
https://github.com/david-lev/mikud

israel-post mikud zipcode

Last synced: 9 months ago
JSON representation

📮 Search for Israeli zip code numbers

• Host: GitHub
• URL: https://github.com/david-lev/mikud
• Owner: david-lev
• License: mit
• Created: 2022-06-10T15:20:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-26T14:53:02.000Z (over 2 years ago)
• Last Synced: 2025-03-26T02:51:17.095Z (10 months ago)
• Topics: israel-post, mikud, zipcode
• Language: Python
• Homepage: https://mikud.readthedocs.io
• Size: 95.7 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
.. image:: https://github.com/david-lev/mikud/blob/master/docs/_static/dark_logo.png?raw=true

  :width: 95

  :alt: Alternative text

.. end-logo

`mikud `_: Search for Israeli zip code numbers

##################################################################################################

.. image:: https://img.shields.io/pypi/dm/mikud?style=flat-square

    :alt: PyPI Downloads

    :target: https://pypi.org/project/mikud/

.. image:: https://www.codefactor.io/repository/github/david-lev/mikud/badge/master

   :target: https://www.codefactor.io/repository/github/david-lev/mikud/overview/master

   :alt: CodeFactor

.. image:: https://readthedocs.org/projects/mikud/badge/?version=latest&style=flat-square

   :target: https://mikud.readthedocs.io

   :alt: 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

--------------

.. installation

- **Install using pip3:**

.. code-block:: bash

    pip3 install -U mikud

- **Install from source:**

.. code-block:: bash

    git clone https://github.com/david-lev/mikud.git

    cd mikud && python3 setup.py install

.. end-installation

🎉 **Features**

---------------

* Search zip code by address

* Search address by zip code

* Get cities

* Get streets

👨‍💻 **Usage**

----------------

.. code-block:: python

    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.**