{"author":"Denis Carriere","author_email":"carriere.denis@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","Intended Audience :: Science/Research","License :: OSI Approved :: Apache Software License","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 2.7","Programming Language :: Python :: 3.3","Programming Language :: Python :: 3.4","Programming Language :: Python :: 3.5","Topic :: Internet","Topic :: Internet :: WWW/HTTP","Topic :: Scientific/Engineering :: GIS","Topic :: Software Development :: Libraries :: Python Modules"],"description":"\n

\n \n $\"Markdownify\"\n$ \n
\n Python Geocoder\n

\n\n

\n Simple and consistent geocoding library written in Python.\n

\n\n

\n \n $\"RDT\"$ \n \n \n $\"PyPi\"$ \n \n \n $\"Snap\"$ \n \n \n $\"Travis\"$ \n \n \n $\"Codecov\"$ \n \n

\n
\n\nTable of content\n----------------\n\n\n\n- [Overview](#overview)\n- [A glimpse at the API](#a-glimpse-at-the-api)\n - [Forward](#forward)\n - [Multiple results](#multiple-results)\n - [Reverse](#reverse)\n - [House Addresses](#house-addresses)\n - [IP Addresses](#ip-addresses)\n - [Bounding Box](#bounding-box)\n- [Command Line Interface](#command-line-interface)\n- [Providers](#providers)\n- [Installation](#installation)\n - [PyPi Install](#pypi-install)\n - [GitHub Install](#github-install)\n - [Snap Install](#snap-install)\n- [Feedback](#feedback)\n- [Contribution](#contribution)\n - [Documenting](#documenting)\n - [Coding](#coding)\n- [ChangeLog](#changelog)\n\n\n\n## Overview\n\nMany online providers such as Google & Bing have geocoding services,\nthese providers do not include Python libraries and have different\nJSON responses between each other.\n\nIt can be very difficult sometimes to parse a particular geocoding provider\nsince each one of them have their own JSON schema.\n\nHere is a typical example of retrieving a Lat & Lng from Google using Python,\nthings shouldn't be this hard.\n\n```python\n>>> import requests\n>>> url = 'https://maps.googleapis.com/maps/api/geocode/json'\n>>> params = {'sensor': 'false', 'address': 'Mountain View, CA'}\n>>> r = requests.get(url, params=params)\n>>> results = r.json()['results']\n>>> location = results[0]['geometry']['location']\n>>> location['lat'], location['lng']\n(37.3860517, -122.0838511)\n```\n\nNow lets use Geocoder to do the same task\n\n```python\n>>> import geocoder\n>>> g = geocoder.google('Mountain View, CA')\n>>> g.latlng\n(37.3860517, -122.0838511)\n```\n\n## A glimpse at the API\n\nMany properties are available once the geocoder object is created.\n\n### Forward\n\n```python\n>>> import geocoder\n>>> g = geocoder.google('Mountain View, CA')\n>>> g.geojson\n>>> g.json\n>>> g.wkt\n>>> g.osm\n```\n\n### Multiple queries ('batch' geocoding)\n\n```python\n>>> import geocoder\n>>> g = geocoder.mapquest(['Mountain View, CA', 'Boulder, Co'], method='batch')\n>>> for result in g:\n... print(result.address, result.latlng)\n...\n('Mountain View', [37.39008, -122.08139])\n('Boulder', [40.015831, -105.27927])\n```\n\n### Multiple results\n\n```python\n>>> import geocoder\n>>> g = geocoder.geonames('Mountain View, CA', maxRows=5)\n>>> print(len(g))\n5\n>>> for result in g:\n... print(result.address, result.latlng)\n...\nMountain View ['37.38605', '-122.08385']\nMountain View Elementary School ['34.0271', '-117.59116']\nBest Western Plus Mountainview Inn and Suites ['51.79516', '-114.62793']\nBest Western Mountainview Inn ['49.3338', '-123.1446']\nMountain View Post Office ['37.393', '-122.07774']\n```\n\n\n> The providers currently supporting multiple results are listed in the table [below](#providers).\n\n### Reverse\n\n```python\n>>> g = geocoder.google([45.15, -75.14], method='reverse')\n>>> g.city\n>>> g.state\n>>> g.state_long\n>>> g.country\n>>> g.country_long\n```\n\n### House Addresses\n\n```python\n>>> g = geocoder.google(\"453 Booth Street, Ottawa ON\")\n>>> g.housenumber\n>>> g.postal\n>>> g.street\n>>> g.street_long\n```\n\n### IP Addresses\n\n```python\n>>> g = geocoder.ip('199.7.157.0')\n>>> g = geocoder.ip('me')\n>>> g.latlng\n>>> g.city\n```\n\n### Bounding Box\n\nAccessing the JSON & GeoJSON attributes will be different\n\n```python\n>>> g = geocoder.google(\"Ottawa\")\n>>> g.bbox\n{\"northeast\": [45.53453, -75.2465979], \"southwest\": [44.962733, -76.3539158]}\n\n>>> g.geojson['bbox']\n[-76.3539158, 44.962733, -75.2465979, 45.53453]\n\n>>> g.southwest\n[44.962733, -76.3539158]\n```\n\n## Command Line Interface\n\n```bash\n$ geocode \"Ottawa, ON\" >> ottawa.geojson\n$ geocode \"Ottawa, ON\" \\\n --provide google \\\n --out geojson \\\n --method geocode\n```\n\n## Providers\n\n| Provider | Optimal | Usage Policy | Multiple results | Reverse | Proximity | Batch |\n|:-------------------------------|:----------|:--------------------------------|:-----------------|:--------|:----------|:------|\n| [ArcGIS][ArcGIS] | World | | yes | yes | | |\n| [Baidu][Baidu] | China | API key | | yes | | |\n| [Bing][Bing] | World | API key | yes | yes | | yes |\n| [CanadaPost][CanadaPost] | Canada | API key | yes | | | |\n| [FreeGeoIP][FreeGeoIP] | World | | | | | |\n| [Gaode][Gaode] | China | API key | | yes | | |\n| [Geocoder.ca][Geocoder.ca] (Geolytica) | CA & US | Rate Limit | | | | |\n| [GeocodeFarm][GeocodeFarm] | World | [Policy][GeocodeFarm-Policy] | yes | yes | | |\n| [GeoNames][GeoNames] | World | Username | yes | | yes | |\n| [GeoOttawa][GeoOttawa] | Ottawa | | yes | | | |\n| [Gisgraphy][Gisgraphy] | World | API key | yes | yes | yes | |\n| [Google][Google] | World | Rate Limit, [Policy][G-Policy] | yes | yes | yes | |\n| [HERE][HERE] | World | API key | yes | yes | | |\n| [IPInfo][IPInfo] | World | Rate Limit, [Plans][IP-Plans] | | | | |\n| [Komoot][Komoot] (OSM powered) | World | | yes | yes | | |\n| [LocationIQ][LocationIQ] | World | API Key | yes | yes | | |\n| [Mapbox][Mapbox] | World | API key | yes | yes | yes | |\n| [MapQuest][MapQuest] | World | API key | yes | yes | | yes |\n| [~~Mapzen~~][Mapzen] | Shutdown | API key | yes | yes | | |\n| [MaxMind][MaxMind] | World | | | | | |\n| [OpenCage][OpenCage] | World | API key | yes | yes | | |\n| [OpenStreetMap][OpenStreetMap] | World | [Policy][OpenStreetMap-Policy] | yes | yes | | |\n| [Tamu][Tamu] | US | API key | | | | |\n| [TGOS][TGOS] | Taiwan | | | | | |\n| [TomTom][TomTom] | World | API key | yes | | | |\n| [USCensus][USCensus] | US | | | yes | | yes |\n| [What3Words][What3Words] | World | API key | | yes | | |\n| [Yahoo][Yahoo] | World | | | | | |\n| [Yandex][Yandex] | Russia | | yes | yes | | |\n\n## Installation\n\n### PyPi Install\n\nTo install Geocoder, simply:\n\n```bash\n$ pip install geocoder\n...\n```\n\n### GitHub Install\n\nInstalling the latest version from Github:\n\n```bash\n$ git clone https://github.com/DenisCarriere/geocoder\n...\n$ cd geocoder\n$ python setup.py install\n...\n```\n\n### Snap Install\n\nTo install the stable geocoder [snap](https://snapcraft.io) in any of the [supported Linux distros](https://snapcraft.io/docs/core/install):\n\n```bash\n$ sudo snap install geocoder\n...\n```\n\nIf you want to help testing the latest changes from the master branch, you can install it from the edge channel:\n\n```bash\n$ sudo snap install geocoder --edge\n...\n```\n\nThe installed snap will be updated automatically every time a new version is pushed to the store.\n\n\n## Feedback\n\nPlease feel free to give any feedback on this module.\n\nSpeak up on Twitter [@DenisCarriere](https://twitter.com/DenisCarriere) and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [#python](https://twitter.com/search?q=%23python).\n\n## Contribution\n\nIf you find any bugs or any enhancements to recommend please send some of your comments/suggestions to the [Github Issues Page](https://github.com/DenisCarriere/geocoder/issues).\n\nSome way to contribute, from the most generic to the most detailed:\n\n### Documenting\n\nIf you are not comfortable with development, you can still contibute with the documentation.\n\n- review the documentation of a specific provider. Most of the time they are lacking details...\n- review the parameters for a specific method, compared to what is supported by the provider\n- review documentation for command line\n\nIf you miss any feature, just create an issue accordingly. Be sure to describe clearly your use case, and to provide links to the correct sources.\n\n### Coding\n\n- add support for a new provider. _Documentation TBD_, starting point possible with [wip_guide](https://geocoder.readthedocs.io/wip_guide.html).\n- extend methods for an existing support, i.e support an additionnal API). _Documentation TBD_\n- extend support of an existing API, i.e, support more (json) fields from the response, or more parameters. _Documentation TBD_\n\n\n## ChangeLog\n\nSee [CHANGELOG.md](./CHANGELOG.md)\n\n\n[TGOS]: http://geocoder.readthedocs.org/providers/TGOS.html\n[Mapbox]: http://geocoder.readthedocs.org/providers/Mapbox.html\n[Google]: http://geocoder.readthedocs.org/providers/Google.html\n[G-Policy]: https://developers.google.com/maps/documentation/geocoding/usage-limits\n[Bing]: http://geocoder.readthedocs.org/providers/Bing.html\n[LocationIQ]: http://geocoder.readthedocs.org/providers/LocationIQ.html\n[OpenStreetMap]: http://geocoder.readthedocs.org/providers/OpenStreetMap.html\n[OpenStreetMap-Policy]: https://operations.osmfoundation.org/policies/nominatim/\n[HERE]: http://geocoder.readthedocs.org/providers/HERE.html\n[TomTom]: http://geocoder.readthedocs.org/providers/TomTom.html\n[MapQuest]: http://geocoder.readthedocs.org/providers/MapQuest.html\n[OpenCage]: http://geocoder.readthedocs.org/providers/OpenCage.html\n[Yahoo]: http://geocoder.readthedocs.org/providers/Yahoo.html\n[ArcGIS]: http://geocoder.readthedocs.org/providers/ArcGIS.html\n[Yandex]: http://geocoder.readthedocs.org/providers/Yandex.html\n[Geocoder.ca]: http://geocoder.readthedocs.org/providers/Geocoder-ca.html\n[Baidu]: http://geocoder.readthedocs.org/providers/Baidu.html\n[GeoOttawa]: http://geocoder.readthedocs.org/providers/GeoOttawa.html\n[FreeGeoIP]: http://geocoder.readthedocs.org/providers/FreeGeoIP.html\n[MaxMind]: http://geocoder.readthedocs.org/providers/MaxMind.html\n[Mapzen]: https://mapzen.com/blog/shutdown\n[What3Words]: http://geocoder.readthedocs.org/providers/What3Words.html\n[CanadaPost]: http://geocoder.readthedocs.org/providers/CanadaPost.html\n[GeoNames]: http://geocoder.readthedocs.org/providers/GeoNames.html\n[IPInfo]: http://geocoder.readthedocs.org/providers/IPInfo.html\n[Tamu]: http://geoservices.tamu.edu/Services/Geocode/WebService/\n[GeocodeFarm]: https://geocode.farm/\n[GeocodeFarm-Policy]: https://geocode.farm/geocoding/free-api-documentation/\n[Gaode]: http://geocoder.readthedocs.org/providers/.html\n[IP-Plans]: http://ipinfo.io/pricing\n[Komoot]: http://photon.komoot.de\n[USCensus]: https://geocoding.geo.census.gov/geocoder/Geocoding_Services_API.html\n[Gisgraphy]: https://premium.gisgraphy.com/\n","description_content_type":"","docs_url":null,"download_url":"https://github.com/DenisCarriere/geocoder","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/DenisCarriere/geocoder","keywords":"geocoder arcgis tomtom opencage google bing here","license":"The MIT License","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"geocoder","package_url":"https://pypi.org/project/geocoder/","platform":"","project_url":"https://pypi.org/project/geocoder/","project_urls":{"Download":"https://github.com/DenisCarriere/geocoder","Homepage":"https://github.com/DenisCarriere/geocoder"},"provides_extra":null,"release_url":"https://pypi.org/project/geocoder/1.38.1/","requires_dist":null,"requires_python":"","summary":"Geocoder is a simple and consistent geocoding library.","version":"1.38.1","yanked":false,"yanked_reason":null}

\n \n \n \n Python Geocoder\n

\n Simple and consistent geocoding library written in Python.\n

\n \n $\"Markdownify\"\n$ \n
\n Python Geocoder\n

Package search

geocoder

project_urls

Dependencies

All package metadata

Releases