Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 3.78 KB

README.textile

File metadata and controls

55 lines (32 loc) · 3.78 KB
Raw
 _____        _____    _____   __    __   __     __
(_   _)      (_   _)  / ___/   ) )  ( (  (_ \   / _)
  | |          | |   ( (__    ( (    ) )   \ \_/ /
  | |          | |    ) __)    ) )  ( (     \   /
  | |   __     | |   ( (      ( (    ) )    / _ \
__| |___) )   _| |__  \ \___   ) \__/ (   _/ / \ \_
\________/   /_____(   \____\  \______/  (__/   \__)

A Djangonic wrapper around the PostGIS geocoder that emulates the Google Maps geocoder’s API.

About

PostGIS v2.0 ships with a built-in but optional U.S. geocoder, which can translate addresses into their approximate geographic coordinates.

This tool, based on the U.S. Census Bureau’s TIGER/Line data, is among the most accurate and capable open-source geocoders available.

Lieux (pr. Lee-YOO) attempts to expose this powerful geocoder as a Web service. Its output closely mimicks that of Google’s geocoding API, and it uses some of Django’s built-in features (including database configuration settings and lists of common state abbreviations) to replicate much of the function of Google’s own geocoder.

Installation

To use Lieux, you first need to have installed the PostGIS geocoder. You can find instructions on doing this here.

Next you’ll want to configure your Django site’s settings.py file to connect to the new database you’ve set up. Add it below your default database by following these instructions, giving it a different alias (key in the DATABASES dict) than ‘default’. (We’ll use ‘geocoder’) for our database alias, but feel free to substitute your own name if you wish.)

After you’ve gotten your geocoder database set up, run ./manage.py syncdb and then ./manage.py dbshell —database , replacing ‘’ with the database alias for your geocoder. If this works, you’ve successfully hooked up the geocoder database to Django’s settings.

Next, you’ll want to add ‘lieux’ to your INSTALLED_APPS list. Add a new setting, GEOCODER_ALIAS, with a value of your database alias (again, ‘geocoder’ unless you opted for something different), run syncdb again and you’re done modifying settings.

Finally, add a line to your URLconf that resembles the following:

    url(r'^maps/', include('lieux.urls')),

And that’s it! You’re ready to start making requests of Lieux.

Usage

A standard request to Lieux resembles the following:

http://www.example.com/maps/api/geocode/json?sensor=false&address=333%20W.%20State%20Street,%20MIlwaukee,%20Wisconsin

Note the JSON-generating view takes two querystring arguments:

  • ‘sensor’, a boolean used to signify whether the device using the API has a location sensor (used only to replicate Google’s existing URL schema), and
  • ‘address’, the address to be geocoded.

The view will return JSON with exactly the same properties as Google’s own geocoding API; you can read about all these parameters here.

Credits

This project couldn’t exist without the wonderful work of the PostGIS and PostgreSQL teams; their geocoder is very impressive for its relative newness. A big ‘thank you’ goes out to all of them.

It also incorporates the data dictionary from latimes-statesyle, compiled by Ben Welsh at the Los Angeles Times. Ben’s code is indispensable in helping to look up states by Associated Press style and many other naming conventions.

In addition, this project draws on several core features of Django that have enabled sane defaults, deep querying and minimal repetition throughout. Thanks as always to those who contribute to its codebase and its success.