Skip to main content

Additional functionality using the GeoIP2 database.

Project description

The master branch of this project is now Python 3.7+ and Django 3.2+ only. Legacy Python and Django versions are tagged.

Django GeoIP2 Extras

Useful extras based on the django.contrib.gis.geoip2 module, using the MaxMind GeoIP2 Lite database.

The first feature in this package is a Django middleware class that can be used to add city, country level information to inbound requests.


This package wraps the existing Django functionality, and as a result relies on the same underlying requirements:

In order to perform IP-based geolocation, the GeoIP2 object
requires the geoip2 Python library and the GeoIP Country and/or City
datasets in binary format (the CSV files will not work!). Grab the
GeoLite2-Country.mmdb.gz and GeoLite2-City.mmdb.gz files and unzip
them in a directory corresponding to the GEOIP_PATH setting.

This package requires Django 3.2 or above.


This package can be installed from PyPI as django-geoip2-extras:

$ pip install django-geoip2-extras

If you want to add the country-level information to incoming requests, add the middleware to your project settings.


The middleware will not be active unless you add a setting for the default GEOIP_PATH - this is the default Django GeoIP2 behaviour:

GEOIP_PATH = os.path.dirname(__file__)

NB Loading this package does not install the (MaxMind database)[]. That is your responsibility. The Country database is 2.7MB, and could be added to most project comfortably, but it is updated regularly, and keeping that up-to-date is out of scope for this project. The City database is 27MB, and is probably not suitable for adding to source control. There are various solutions out on the web for pulling in the City database as part of a CD process.


Once the middleware is added, you will be able to access City and / or Country level information on the request object.

The raw data is added to the request and response headers:

$ curl -I -H "x-forwarded-for:" localhost:8000
HTTP/1.1 200 OK
Date: Sun, 29 Aug 2021 15:47:22 GMT
Server: WSGIServer/0.2 CPython/3.9.4
Content-Type: text/html
X-GeoIP2-Continent-Code: NA
X-GeoIP2-Continent-Name: North America
X-GeoIP2-Country-Code: US
X-GeoIP2-Country-Name: United States
X-GeoIP2-Is-In-European-Union: False
X-GeoIP2-Latitude: 37.751
X-GeoIP2-Longitude: -97.822
X-GeoIP2-Time-Zone: America/Chicago
Content-Length: 10697

This is available from your code via the request.headers object (the keys are case insensitive):

>>> request.headers["x-geoip2-city"]
'Beverley Hills'
>>> request.headers["x-geoip2-postal-code"]
>>> request.headers["x-geoip2-region"]
>>> request.headers["x-geoip2-country-code"]
>>> request.headers["x-geoip2-country-name"]
'United States'
>>> request.headers["x-geoip2-latitude"]
>>> request.headers["x-geoip2-longitude"]

Missing / incomplete data will be and empty string "".

If the IP address cannot be found (e.g. ''), then a default 'unknown' country is used, with a code of 'XX'.


The project tests are run through pytest.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-geoip2-extras-2.0b0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

django_geoip2_extras-2.0b0-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page