Django Geonames Place

https://travis-ci.org/kingsdigitallab/django-geonames-place.svg?branch=master https://codecov.io/gh/kingsdigitallab/django-geonames-place/branch/master/graph/badge.svg

Application to access Geonames Places directly from Django. The application can create places by using a geonames id or by using a search address.

This application depends on the very useful Python Geocoder library.

Documentation

The full documentation is at https://django-geonames-place.readthedocs.io.

Quickstart

Install Django Geonames Place:

pip install django-geonames-place

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'geonames_place.apps.GeonamesPlaceConfig',
    ...
)

Add the settings GEONAMES_KEY and GEONAMES_MAX_RESULTS. The GEONAMES_KEY is your Geoname API key, and the GEONAMES_MAX_RESULTS is used to set the maximum number of results when searching Geonames.

GEONAMES_KEY = '<GEONAMES_USERNAME>'
GEONAMES_MAX_RESULTS = 10

To reference Geonames Place in your models:

from django.db import models
from geonames_place.models import Place


class MyModel(models.Model):
    ...
    place = models.ForeignKey(Place, on_delete=models.CASCADE)
    ...
]

Features

  • TODO

Running Tests

Does the code actually work?

export GEONAMES_KEY=<GEONAMES_USERNAME>
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package: