{"id":17009451,"url":"https://github.com/david-lev/mikud","last_synced_at":"2025-04-12T07:43:58.873Z","repository":{"id":38018281,"uuid":"502089975","full_name":"david-lev/mikud","owner":"david-lev","description":"📮 Search for Israeli zip code numbers","archived":false,"fork":false,"pushed_at":"2023-09-26T14:53:02.000Z","size":98,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T02:51:17.095Z","etag":null,"topics":["israel-post","mikud","zipcode"],"latest_commit_sha":null,"homepage":"https://mikud.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/david-lev.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-10T15:20:25.000Z","updated_at":"2024-12-25T14:46:22.000Z","dependencies_parsed_at":"2022-09-14T01:02:14.055Z","dependency_job_id":null,"html_url":"https://github.com/david-lev/mikud","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/david-lev%2Fmikud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/david-lev%2Fmikud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/david-lev%2Fmikud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/david-lev%2Fmikud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/david-lev","download_url":"https://codeload.github.com/david-lev/mikud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248170498,"owners_count":21059201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["israel-post","mikud","zipcode"],"created_at":"2024-10-14T05:43:33.681Z","updated_at":"2025-04-12T07:43:58.839Z","avatar_url":"https://github.com/david-lev.png","language":"Python","readme":".. image:: https://github.com/david-lev/mikud/blob/master/docs/_static/dark_logo.png?raw=true\n  :width: 95\n  :alt: Alternative text\n.. end-logo\n\n`mikud \u003chttps://github.com/david-lev/mikud\u003e`_: Search for Israeli zip code numbers\n##################################################################################################\n\n.. image:: https://img.shields.io/pypi/dm/mikud?style=flat-square\n    :alt: PyPI Downloads\n    :target: https://pypi.org/project/mikud/\n\n.. image:: https://www.codefactor.io/repository/github/david-lev/mikud/badge/master\n   :target: https://www.codefactor.io/repository/github/david-lev/mikud/overview/master\n   :alt: CodeFactor\n\n.. image:: https://readthedocs.org/projects/mikud/badge/?version=latest\u0026style=flat-square\n   :target: https://mikud.readthedocs.io\n   :alt: Docs\n\n\n________________________\n\n☎️ mikud is a Python3 library to search israel's zip codes (mikud) by their addresses.\n\n📖 For a **complete documentation** of available functions, see the `Reference \u003chttps://mikud.readthedocs.io/en/latest/#id1\u003e`_.\n\n\u003e\u003e️ *This tool based on israelpost website -* `Click here \u003chttps://israelpost.co.il/%D7%A9%D7%99%D7%A8%D7%95%D7%AA%D7%99%D7%9D/%D7%90%D7%99%D7%AA%D7%95%D7%A8-%D7%9E%D7%99%D7%A7%D7%95%D7%93/\u003e`_.\n\n\n🎛 Installation\n--------------\n.. installation\n\n- **Install using pip3:**\n\n.. code-block:: bash\n\n    pip3 install -U mikud\n\n- **Install from source:**\n\n.. code-block:: bash\n\n    git clone https://github.com/david-lev/mikud.git\n    cd mikud \u0026\u0026 python3 setup.py install\n\n.. end-installation\n\n🎉 **Features**\n---------------\n\n* Search zip code by address\n* Search address by zip code\n* Get cities\n* Get streets\n\n👨‍💻 **Usage**\n----------------\n.. code-block:: python\n\n    from mikud import Mikud\n\n    mikud = Mikud()\n    mikud_res = mikud.search_mikud(city_name=\"ירושלים\",\n                                   street_name=\"כנפי נשרים\",\n                                   house_number=\"20\")\n    print(mikud_res.zip)\n    #\u003e 9546432\n\n    addr = mikud.search_address(zip_code=9546432)\n    print(addr.city_name, addr.street_name, addr.house_number)\n    #\u003e ירושלים כנפי נשרים 20\n\n\n💾 **Requirements**\n--------------------\n\n- Python 3.6 or higher - https://www.python.org\n\n📖 **Setup and Usage**\n-----------------------\n\nSee the `Documentation \u003chttps://mikud.readthedocs.io/\u003e`_ for detailed instructions\n\n⛔ **Disclaimer**\n------------------\n\n**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.**\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavid-lev%2Fmikud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavid-lev%2Fmikud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavid-lev%2Fmikud/lists"}