Skip to main content

django-earthdistance

Using PostgreSQL’s EarthDistance extension for django >= 1.8 (for older versions see with_djorm_expressions branch)*

Earthdistance allows to do fast geolocalized queries without using PostGIS

https://pypip.in/v/django-earthdistance/badge.png https://pypip.in/d/django-earthdistance/badge.png

Tested with python 2.7 and 3.3

Usage

Cube and EarthDistance extensions must be enabled in postgreSQL BD, so log in database using pgsql and install extensions:

=> create extension cube;
=> create extension earthdistance;

Filter by rows inside a circunference of radius r

from django.db import models

from django_earthdistance.models import EarthDistanceQuerySet

class MyModel(models.Model):
    latitute = models.FloatField()
    longitude = models.FloatField()

    objects = EarthDistanceQuerySet.as_manager()

# Define fields to query in DistanceExpression initialization
# search with lat=0.2546 and lon=-38.25 and distance 1500 meters
# use param `annotate` to set a custom field for the distance, `_ed_distance` as default

MyModel.objects.in_distance(1500, fields=['latitude', 'longitude'], points=[0.2546, -38.25])

Annotate each row returned by a query with distance between two points

from django_earthdistance.models import EarthDistance, LlToEarth

MyModel.objects.filter(....).annotate(
    distance=EarthDistance(
        LlToEarth([0.2546, -38.25]),
        LlToEarth(['latitude', 'longitude'])))

Optimizing perfomance with indexes

PostgreSQL allow to use GiST indexes with functions results, a good perfomance improvement is to store ll_to_earth results in an index, ll_to_earth is a function that calculates the position of a point on the surface of the earth (assuming earth is perfectly spherical)

-- Example MyModel table is app_mymodel and points columns are latitude and longitude
CREATE INDEX mymodel_location ON app_mymodel USING gist (ll_to_earth(latitude, longitude));

Also, using south is preferred, just add this migration to migrations/ folder and edit it to your needs, index will be created

class Migration(SchemaMigration):

    def forwards(self, orm):
        cursor = connection.cursor()
        cursor.execute("CREATE INDEX mymodel_location ON app_mymodel USING gist (ll_to_earth(latitude, longitude));")


    def backwards(self, orm):
        # Deleting field 'Venue.coords'
        cursor = connection.cursor()
        cursor.execute("DROP INDEX mymodel_location ON app_mymodel;")

Metadata

Release files for django-earthdistance 1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-earthdistance 1
File Size Uploaded Provenance Actions
django-earthdistance-1.tar.gz 8.2 kB Without provenance Details for django-earthdistance-1.tar.gz

Release files / django-earthdistance-1.tar.gz

Download URL django-earthdistance-1.tar.gz
Size 8.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4f41a101ac53c3fa3078057ab5c84ddbf7e24ba00d3b3ffb79e833bcf7869f90
BLAKE2b-256 checksum
How to use checksums
002b6580953b80e68b54613bbece16de1c7e2f88d337342f7a1d748e5fdf32df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-earthdistance 1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page