The API is based on [MaxMind's C-based Python API](http://www.maxmind.com/app/python),
The API is based on [MaxMind's C-based Python API](http://www.maxmind.com/app/python),
but the code itself is ported from the [Pure PHP GeoIP API](http://pear.php.net/package/Net_GeoIP) by Jim Winstead and Hans Lellelid.
but the code itself is ported from the [Pure PHP GeoIP API](http://pear.php.net/package/Net_GeoIP) by Jim Winstead and Hans Lellelid.
It is mostly a drop-in replacement, except the `new` and `open` methods are gone.
It is mostly a drop-in replacement, except the `new` and `open` methods are gone.
Tested using tox with Python version 2.5, 2.6, 2.7, 3.0 and 3.1.
Tested using tox with Python version 2.5, 2.6, 2.7, 3.0 and 3.1.
## Issues and contribution ##
## Issues and contribution ##
Bug reports are done by [creating an issue on Github](https://github.com/appliedsec/pygeoip/issues). If you want to contribute you can always [create a pull request](https://github.com/appliedsec/pygeoip/pulls) for discussion and code submission.
Bug reports are done by [creating an issue on Github](https://github.com/appliedsec/pygeoip/issues). If you want to contribute you can always [create a pull request](https://github.com/appliedsec/pygeoip/pulls) for discussion and code submission.
## Installation ##
## Installation ##
You can easily install pygeoip with setuptools:
You can easily install pygeoip with setuptools:
easy_install pygeoip
easy_install pygeoip
## Supported Databases ##
## Supported Databases ##
* Country
* Country
* Region
* Region
* City
* City
* Organization
* Organization
* ISP
* ISP
## Quick Documentation ##
## Quick Documentation ##
Create your GeoIP instance with appropriate access flag. `STANDARD` reads data from disk when needed, `MEMORY_CACHE` loads database into memory on instantiation and `MMAP_CACHE` loads database into memory using mmap.
Create your GeoIP instance with appropriate access flag. `STANDARD` reads data from disk when needed, `MEMORY_CACHE` loads database into memory on instantiation and `MMAP_CACHE` loads database into memory using mmap.
import pygeoip
import pygeoip
gi = pygeoip.GeoIP('/path/to/GeoIP.dat', pygeoip.MEMORY_CACHE)
gi = pygeoip.GeoIP('/path/to/GeoIP.dat', pygeoip.MEMORY_CACHE)
### Country lookup ###
### Country lookup ###
>>> gi.country_code_by_name('google.com')
>>> gi.country_code_by_name('google.com')
'US'
'US'
>>> gi.country_code_by_addr('64.233.161.99')
>>> gi.country_code_by_addr('64.233.161.99')
'US'
'US'
>>> gi.country_name_by_addr('64.233.161.99')
>>> gi.country_name_by_addr('64.233.161.99')
'United States'
'United States'
### City lookup ###
### City lookup ###
>>> gic = pygeoip.GeoIP('/path/to/GeoIPCity.dat')
>>> gic = pygeoip.GeoIP('/path/to/GeoIPCity.dat')
>>> gic.record_by_addr('64.233.161.99')
>>> gic.record_by_addr('64.233.161.99')
{
{
'city': 'Mountain View',
'city': 'Mountain View',
'region_name': 'CA',
'region_name': 'CA',
'area_code': 650,
'area_code': 650,
'longitude': -122.0574,
'longitude': -122.0574,
'country_code3': 'USA',
'country_code3': 'USA',
'latitude': 37.419199999999989,
'latitude': 37.419199999999989,
'postal_code': '94043',
'postal_code': '94043',
'dma_code': 807,
'dma_code': 807,
'country_code': 'US',
'country_code': 'US',
'country_name': 'United States'
'country_name': 'United States'
}
}
### Timezone lookup ###
### Timezone lookup ###
>>> gic = pygeoip.GeoIP('/path/to/GeoIPCity.dat')
>>> gic = pygeoip.GeoIP('/path/to/GeoIPCity.dat')
>>> gic.time_zone_by_addr('64.233.161.99')
>>> gic.time_zone_by_addr('64.233.161.99')
'America/Los_Angeles'
'America/Los_Angeles'
For more information, [check out the full API documentation](http://packages.python.org/pygeoip).
For more information, [check out the full API documentation](http://packages.python.org/pygeoip).
