{ "info": { "author": "Sanhe Hu", "author_email": "husanhe@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": ".. image:: https://travis-ci.org/MacHu-GWU/cazipcode-project.svg?branch=master\r\n\r\n.. image:: https://img.shields.io/pypi/v/cazipcode.svg\r\n\r\n.. image:: https://img.shields.io/pypi/l/cazipcode.svg\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/cazipcode.svg\r\n\r\n\r\nWelcome to cazipcode Documentation\r\n==================================\r\nPowerful Canada zipcode search engine. Powerful geo lat lng search, fuzzy province, city name search out of the box. And powerful search API with high performance sorting.\r\n\r\n\r\n**Quick Links**\r\n---------------\r\n- `GitHub Homepage `_\r\n- `Online Documentation `_\r\n- `PyPI download `_\r\n- `Install `_\r\n- `Issue submit and feature request `_\r\n- `API reference and source code `_\r\n\r\n\r\n**Features**\r\n------------\r\n- **200,000 + postal code covers most of the place.**\r\n\r\n- **Rich information of postalcode is available**:\r\n\r\n.. code-block:: json\r\n\r\n {\r\n \"postalcode\": \"K1G 0A1\",\r\n \"province\": \"ON\",\r\n \"city\": \"Ottawa\",\r\n \"area_name\": \"Ottawa\",\r\n \"area_code\": 613,\r\n \"latitude\": 45.417874,\r\n \"longitude\": -75.648284,\r\n \"population\": 33994,\r\n \"dwellings\": 14817,\r\n \"elevation\": 56,\r\n \"timezone\": 5,\r\n \"day_light_savings\": 1\r\n }\r\n\r\n- **Human friendly API**\r\n\r\n.. code-block:: python\r\n\r\n from cazipcode import fields, SearchEngine\r\n\r\n with SearchEngine() as search:\r\n # built-in geo search\r\n result = search.near(lat=45.477873, lng=-75.721100, radius=100)\r\n\r\n # by province, fuzzy name search.\r\n result = search.by_province(\"on\")\r\n\r\n # by city, fuzzy name search.\r\n result = search.by_city(\"otawa\")\r\n\r\n # easy to sort and limit result\r\n # Top 5 high population postal ocde in ON\r\n result = search.by_province(\"on\",\r\n sort_by=fields.province, ascending=False, returns=10)\r\n\r\n # by population dwellings timezone\r\n result = search.by_population(population_greater=10000)\r\n result = search.by_dwellings(dwellings_greater=10000)\r\n result = search.by_timezone(timezone_greater=5, timezone_less=8)\r\n\r\n # by 3-d space\r\n (\r\n lat_greater, lat_less, lng_greater, lng_less,\r\n elevation_greater, elevation_less,\r\n ) = None, None, None, None, None, None\r\n result = search.by_lat_lng_elevation(\r\n lat_greater, lat_less, lng_greater, lng_less,\r\n elevation_greater, elevation_less,\r\n )\r\n\r\n\r\n- **Powerful query**\r\n\r\n.. code-block:: python\r\n\r\n from cazipcode import fields, SearchEngine\r\n\r\n # combination of any criterions\r\n result = search.find(\r\n lat=None, lng=None, radius=None,\r\n lat_greater=None, lat_less=None,\r\n lng_greater=None, lng_less=None,\r\n elevation_greater=None, elevation_less=None,\r\n prefix=None,\r\n substring=None,\r\n province=None, city=None, area_name=None,\r\n area_code=None,\r\n population_greater=None, population_less=None,\r\n dwellings_greater=None, dwellings_less=None,\r\n timezone=None, timezone_greater=None, timezone_less=None,\r\n day_light_savings=None,\r\n sort_by=None,\r\n ascending=True,\r\n returns=5,\r\n )\r\n\r\n\r\n.. _install:\r\n\r\nInstall\r\n-------\r\n\r\n``cazipcode`` is released on PyPI, so all you need is:\r\n\r\n.. code-block:: console\r\n\r\n\t$ pip install cazipcode\r\n\r\nTo upgrade to latest version:\r\n\r\n.. code-block:: console\r\n\r\n\t$ pip install --upgrade cazipcode", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/MacHu-GWU/cazipcode-project/tarball/2017-07-13", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/MacHu-GWU/cazipcode-project", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "cazipcode", "package_url": "https://pypi.org/project/cazipcode/", "platform": "Windows", "project_url": "https://pypi.org/project/cazipcode/", "project_urls": { "Download": "https://github.com/MacHu-GWU/cazipcode-project/tarball/2017-07-13", "Homepage": "https://github.com/MacHu-GWU/cazipcode-project" }, "release_url": "https://pypi.org/project/cazipcode/0.0.2/", "requires_dist": null, "requires_python": "", "summary": "Powerful Canada zipcode search engine.", "version": "0.0.2" }, "last_serial": 3021509, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "ba5296d041ed42f5cdcaf9c6dd3a219c", "sha256": "9ba6c67e8785ed953297d96e00786a477191fa5044ab8f6d883e95a4007eee43" }, "downloads": -1, "filename": "cazipcode-0.0.1.tar.gz", "has_sig": false, "md5_digest": "ba5296d041ed42f5cdcaf9c6dd3a219c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14565049, "upload_time": "2017-07-13T20:53:59", "url": "https://files.pythonhosted.org/packages/58/93/123fc0ab239a980368e63b21fd05053b909293ce888448dcccebe5c44fd3/cazipcode-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "aa1ac182aae2474e4b7cd63d0cd74183", "sha256": "6ae73ad3cb0121b3e0f14d01ec3d6ed5bf2cd576e1c88ac5ec7e0ce246a6352b" }, "downloads": -1, "filename": "cazipcode-0.0.2.tar.gz", "has_sig": false, "md5_digest": "aa1ac182aae2474e4b7cd63d0cd74183", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2891335, "upload_time": "2017-07-13T21:24:50", "url": "https://files.pythonhosted.org/packages/83/c5/1c1c145a39bdd541fb17bc1d0333ac2eaf66b571b9ed9148c3844b31877c/cazipcode-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aa1ac182aae2474e4b7cd63d0cd74183", "sha256": "6ae73ad3cb0121b3e0f14d01ec3d6ed5bf2cd576e1c88ac5ec7e0ce246a6352b" }, "downloads": -1, "filename": "cazipcode-0.0.2.tar.gz", "has_sig": false, "md5_digest": "aa1ac182aae2474e4b7cd63d0cd74183", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2891335, "upload_time": "2017-07-13T21:24:50", "url": "https://files.pythonhosted.org/packages/83/c5/1c1c145a39bdd541fb17bc1d0333ac2eaf66b571b9ed9148c3844b31877c/cazipcode-0.0.2.tar.gz" } ] }