The GeoIP2 object is a wrapper for the MaxMind geoip2 Python\nlibrary. [1]
In order to perform IP-based geolocation, the GeoIP2 object requires\nthe geoip2 Python package and the GeoIP Country and/or City\ndatasets in binary format (the CSV files will not work!), downloaded from e.g.\nMaxMind or DB-IP websites. Grab the GeoLite2-Country.mmdb.gz and\nGeoLite2-City.mmdb.gz files and unzip them in a directory corresponding to\nthe GEOIP_PATH setting.
Additionally, it is recommended to install the libmaxminddb C library, so\nthat geoip2 can leverage the C library’s faster speed.
Here is an example of its usage:
\n>>> from django.contrib.gis.geoip2 import GeoIP2\n>>> g = GeoIP2()\n>>> g.country("google.com")\n{'country_code': 'US', 'country_name': 'United States'}\n>>> g.city("72.14.207.99")\n{'city': 'Mountain View',\n'continent_code': 'NA',\n'continent_name': 'North America',\n'country_code': 'US',\n'country_name': 'United States',\n'dma_code': 807,\n'is_in_european_union': False,\n'latitude': 37.419200897216797,\n'longitude': -122.05740356445312,\n'postal_code': '94043',\n'region': 'CA',\n'time_zone': 'America/Los_Angeles'}\n>>> g.lat_lon("salon.com")\n(39.0437, -77.4875)\n>>> g.lon_lat("uh.edu")\n(-95.4342, 29.834)\n>>> g.geos("24.124.1.80").wkt\n'POINT (-97 38)'\nThe 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 datasets. 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( | \n
| \nThe cache settings when opening up the GeoIP datasets. May\nbe an integer in (0, 1, 2, 4, 8) corresponding to the\n | \n
| \nThe name of the GeoIP country data file. Defaults\nto | \n
| \nThe name of the GeoIP city data file. Defaults to\n | \n
This classmethod instantiates the GeoIP object from the given database path\nand given cache setting.
\nAll 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 the country code corresponding to the query.
\nReturns 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 Point object corresponding to the\nquery.
GEOIP_PATHLink to this heading#A string or pathlib.Path specifying the directory where the GeoIP data\nfiles are located. This setting is required unless manually specified\nwith path keyword when initializing the GeoIP2 object.
GEOIP_COUNTRYLink to this heading#The basename to use for the GeoIP country data file. Defaults to\n'GeoLite2-Country.mmdb'.
GEOIP_CITYLink to this heading#The basename to use for the GeoIP city data file. Defaults to\n'GeoLite2-City.mmdb'.
The exception raised when an error occurs in a call to the underlying\ngeoip2 library.
Footnotes
\n\n