Metadata-Version: 2.0
Name: django-geohash-cluster
Version: 0.1.0
Summary: High efficient clustering algorithm based on geohash of points
Home-page: https://github.com/EvgeneOskin/django-geohash-cluster
Author: Your full name here
Author-email: Eugene Oskin: eoskin@crystalnix.com
License: MIT
Keywords: django-geohash-cluster
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: django (>=1.8)
Provides-Extra: rest
Requires-Dist: django-filter; extra == 'rest'
Requires-Dist: django-rest-framework; extra == 'rest'
Requires-Dist: djangorestframework-gis; extra == 'rest'
Requires-Dist: python-geohash; extra == 'rest'

=============================
django geohash cluster
=============================

.. image:: https://badge.fury.io/py/django-geohash-cluster.svg
    :target: https://badge.fury.io/py/django-geohash-cluster

.. image:: https://travis-ci.org/EvgeneOskin/django-geohash-cluster.svg?branch=master
    :target: https://travis-ci.org/EvgeneOskin/django-geohash-cluster

.. image:: https://codecov.io/gh/EvgeneOskin/django-geohash-cluster/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/EvgeneOskin/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`:

.. code-block:: python

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

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

.. code-block:: bash

    $ pip install geohash_cluster[rest]

.. code-block:: python

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


Features
--------

* A `Pointed` model with `PointField`.

Running Tests
-------------

Install dependencies:


.. code-block:: bash

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


Does the code actually work?

.. code-block:: bash

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

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.1.0 (2017-07-25)
++++++++++++++++++

* First release on PyPI.


