README.rst

django geohash cluster

High efficient clustering algorithm based on geohash of points

Documentation

The full documentation is at https://django-geohash-cluster.readthedocs.io.

Quickstart

Install django geohash cluster:

pip install django-geohash-cluster

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'geohash_cluster',
    ...
)

To use with :Django Rest Framework:http://www.django-rest-framework.org/

$ pip install geohash_cluster[rest]

INSTALLED_APPS = (
    ...
    'rest_framework',
    'rest_framework_gis',
    ...
    'geohash_cluster',
    ...
)

Features

• A Pointed model with PointField.

Running Tests

Install dependencies:

$ pipenv install --dev
$ pip install .[rest]

Does the code actually work?

$ source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage