Metadata-Version: 2.1
Name: django-geoipdb-loader
Version: 1.0.0
Summary: Helps download and keep updated maxmind's geoip db required for django GeoIP
Home-page: https://github.com/kalekseev/django-geoipdb-loader
Author: Konstantin Alekseev
Author-email: kv.alekseev@gmail.com
License: UNKNOWN
Keywords: django,geoip
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8

======================
Django GeoIP DB Loader
======================



Helps download and keep updated maxmind's geoip db required for `django GeoIP <https://docs.djangoproject.com/en/1.10/ref/contrib/gis/geoip2/>`_

For Django 2.2+ and python 3.6+. For older versions use `pip install django-geoipdb-loader<1.0`.


Why and when to use?
====================

If you don't mind installing and configuring
`official geoipupdate <http://dev.maxmind.com/geoip/geoipupdate/>`_ on your server
then I'd recommend to use it.
If you want a simple method to download db files via django command or schedule
updates using celery then this app is the way to go.


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

Using pip::

    pip install django-geoipdb-loader

Add the app to INSTALLED_APPS and configure GEOIP_PATH::

    INSTALLED_APPS = [
        ...
        geoipdb_loader,
        ...
    ]

    GEOIP_PATH = '/myproject/geoip'
    MAXMIND_LICENSE_KEY = 'your license key'


Usage
=====

Run :code:`manage.py download_geoipdb` to download geoip files.

In order to automatically update the geoip files you can use provided celery task::

    CELERYBEAT_SCHEDULE = {
        'update-geoipdb': {
            'task': 'geoipdb_loader.tasks.update_geoipdb',
            'schedule': crontab(day_of_week=6),
        },
    }

or crontab::

    * * * * 6 manage.py download_geoipdb


