django-geoip-redis¶

Compatibility¶

• Python: 2.6, 2.7, 3.3
• Django: 1.3.x, 1.4.x, 1.5.x, 1.6

Recommended way to install is via pip:

pip install django-geoip-redis

Basic¶

• Add geoip to INSTALLED_APPS in settings.py:

  INSTALLED_APPS = (
      ...
      'geoip',
      ...
  )
  

• Create application tables on database:

  python manage.py syncdb
  

  If you’re using South:

  python manage.py migrate
  

• Get latest data to perform geoip detection by running management command:

  python manage.py update_geo_db
  

Advanced¶

In order to make user’s location detection automatic several other steps are required:

• Add GeoMiddleware to MIDDLEWARE_CLASSES:

  MIDDLEWARE_CLASSES = (
      ...
      'geoip.middleware.GeoMiddleware',
  )
  

Low-level API usage¶

Low-level API allows you to guess user’s location by his IP address. This function returns dictionary associated with IP’s city, area, country, isp and provider.

Here is a basic example:

from geoip.geo import record_by_ip_as_dict

ip = '91.195.136.52'

geoip_record = record_by_ip_as_dict(ip)

if geoip_record is not None:
    print geoip_record.get('country')
    print geoip_record.get('area')
    print geoip_record.get('city')
    print geoip_record.get('isp')
    print geoip_record.get('provider')
else:
    print 'Unknown location'

High-level API usage¶

The app provides a convenient way to detect user location automatically. If you’ve followed advanced installation instructions, user’s location should be accessible via request object:

def my_view(request):
    """ Passing location into template """
    ...
    context['geo'] = request.geo
    ...

Data storage¶

All geoip data, including geography and geoip mapping is stored in the database. To avoid unnecessary database hits user location is stored in a cookie.

Backends¶

There is currently no infrastructure to use alternative geoip backends, but it’s planned for future releases. Pull requests are also welcome.