Metadata-Version: 2.1
Name: django-geoip2-extras
Version: 1.3
Summary: Additional functionality using the GeoIP2 database.
Home-page: https://github.com/yunojuno/django-geoip2-extras
License: MIT
Author: YunoJuno
Author-email: code@yunojuno.com
Maintainer: YunoJuno
Maintainer-email: code@yunojuno.com
Requires-Python: >=3.7,<4.0
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: django (>=2.2,<4.0)
Requires-Dist: geoip2 (>=3.0.0,<4.0.0)
Requires-Dist: python-env-utils
Project-URL: Repository, https://github.com/yunojuno/django-geoip2-extras
Description-Content-Type: text/x-rst

.. image:: https://badge.fury.io/py/django-geoip2-extras.svg
    :target: https://badge.fury.io/py/django-geoip2-extras

.. image:: https://travis-ci.org/yunojuno/django-geoip2-extras.svg
    :target: https://travis-ci.org/yunojuno/django-geoip2-extras

**The master branch of this project is now Python 3.7+ and Django 2.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 <http://dev.maxmind.com/geoip/geoip2/geolite2/>`_ 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.

Requirements
============

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.*

In addition, the middleware follows the 'new' middleware pattern, and therefore
does **not** support Django 1.9 or below. This is a 1.10 and above package.

Installation
============

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

.. code:: shell

    $ pip install django-geoip2-extras

If you want to add the country-level information to incoming requests, add the
middleware to your project settings. NB The ``GeoIP2Middleware`` relies on the ``SessionMiddleware``, and must come after it:

.. code:: python

    MIDDLEWARE = (
        ...,
        'django.contrib.sessions.middleware.SessionMiddleware',
        'geoip2_extras.middleware.GeoIP2Middleware',
        ...
    )

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

.. code:: python

    # settings.py
    GEOIP_PATH = os.path.dirname(__file__)

NB Loading this package does *not* install the `MaxMind database <http://dev.maxmind.com/geoip/geoip2/geolite2/>`_.
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.

Usage
=====

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

.. code:: python

    >>> request.geo_data.ip_address
    '1.2.3.4'
    >>> request.geo_data.city
    'Beverley Hills'
    >>> request.geo_data.postal_code
    '90210'
    >>> request.geo_data.region
    'California'
    >>> request.geo_data.country_code
    'US'
    >>> request.geo_data.country_name
    'United States'
    >>> request.geo_data.latitude
    '34.0736'
    >>> request.geo_data.longitude
    '118.4004'

Missing / incomplete data will be None.

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

.. code:: python

    >>> geo.ip_address
    '127.0.0.1'
    >>> geo.country_code
    'XX'
    >>> geo.country_name
    'unknown'
    >>> geo.is_unknown
    True

This prevents the middleware from re-requesting the address on each request - it effectively marks the IP as a bad address.

Tests
=====

The project tests are run through ``tox``.

