The GeoIP object is a ctypes wrapper for the\nMaxMind GeoIP C API. [1]
In order to perform IP-based geolocation, the GeoIP object requires\nthe GeoIP C library and either the GeoIP Country or City\ndatasets in binary format (the CSV files will not work!). These datasets may be\ndownloaded from MaxMind. Grab the GeoLiteCountry/GeoIP.dat.gz and\nGeoLiteCity.dat.gz files and unzip them in a directory corresponding to what\nyou set GEOIP_PATH with in your settings. See the example and\nreference below for more details.
Assuming you have the GeoIP C library installed, here is an example of its\nusage:
\n>>> from django.contrib.gis.geoip import GeoIP\n>>> g = GeoIP()\n>>> g.country('google.com')\n{'country_code': 'US', 'country_name': 'United States'}\n>>> g.city('72.14.207.99')\n{'area_code': 650,\n'city': 'Mountain View',\n'country_code': 'US',\n'country_code3': 'USA',\n'country_name': 'United States',\n'dma_code': 807,\n'latitude': 37.419200897216797,\n'longitude': -122.05740356445312,\n'postal_code': '94043',\n'region': 'CA'}\n>>> g.lat_lon('salon.com')\n(37.789798736572266, -122.39420318603516)\n>>> g.lon_lat('uh.edu')\n(-95.415199279785156, 29.77549934387207)\n>>> g.geos('24.124.1.80').wkt\n'POINT (-95.2087020874023438 39.0392990112304688)'\nGeoIP SettingsLink to this heading#GEOIP_PATHLink to this heading#A string specifying the directory where the GeoIP data files are\nlocated. This setting is required unless manually specified\nwith path keyword when initializing the GeoIP object.
GEOIP_LIBRARY_PATHLink to this heading#A string specifying the location of the GeoIP C library. Typically,\nthis setting is only used if the GeoIP C library is in a non-standard\nlocation (e.g., /home/sue/lib/libGeoIP.so).
GEOIP_COUNTRYLink to this heading#The basename to use for the GeoIP country data file.\nDefaults to 'GeoIP.dat'.
GEOIP_CITYLink to this heading#The basename to use for the GeoIP city data file.\nDefaults to 'GeoLiteCity.dat'.
GeoIP APILink to this heading#The GeoIP object does not require any parameters to use the default\nsettings. However, at the very least the GEOIP_PATH setting\nshould be set with the path of the location of your GeoIP data sets. The\nfollowing initialization keywords may be used to customize any of the\ndefaults.
Keyword Arguments | \nDescription | \n
|---|---|
| \nBase directory to where GeoIP data is located or the\nfull path to where the city or country data files\n(.dat) are located. Assumes that both the city and\ncountry data sets are located in this directory;\noverrides the | \n
| \nThe cache settings when opening up the GeoIP datasets,\nand may be an integer in (0, 1, 2, 4) corresponding to\nthe | \n
| \nThe name of the GeoIP country data file. Defaults\nto | \n
| \nThe name of the GeoIP city data file. Defaults to\n | \n
GeoIP MethodsLink to this heading#All the following querying routines may take either a string IP address\nor a fully qualified domain name (FQDN). For example, both\n'205.186.163.125' and 'djangoproject.com' would be valid query\nparameters.
Returns a dictionary of city information for the given query. Some\nof the values in the dictionary may be undefined (None).
Returns a dictionary with the country code and country for the given\nquery.
\nReturns only the country code corresponding to the query.
\nReturns only the country name corresponding to the query.
\nReturns a coordinate tuple of (longitude, latitude).
\nReturns a coordinate tuple of (longitude, latitude).
\nReturns a coordinate tuple of (latitude, longitude),
\nReturns a django.contrib.gis.geos.Point object corresponding to the query.
This property returns information about the GeoIP country database.
\nThis property returns information about the GeoIP city database.
\nThis property returns information about all GeoIP databases (both city\nand country), and the version of the GeoIP C library (if supported).
\nThese methods exist to ease compatibility with any code using MaxMind’s\nexisting Python API.
\nThis classmethod instantiates the GeoIP object from the given database path\nand given cache setting.
\nFootnotes
\n\n