dj-places 1.1.3

A django app for store places

django-places
=============================

A Django app for store places with autocomplete function and a related map to the selected place.

Badges
---------

[](https://badge.fury.io/py/dj-places)
[](https://travis-ci.org/oscarmcm/django-places)
[](https://www.codacy.com/app/om-cortez-2010/django-places?utm_source=github.com&utm_medium=referral&utm_content=oscarmcm/django-places&utm_campaign=Badge_Grade)

Quickstart
----------

Install dj-places and add it to your installed apps:

$ pip install dj-places

INSTALLED_APPS = (
...
'places',
...
)

Add the following settings and maps api key ( [read more here](https://developers.google.com/maps/documentation/javascript/3.exp/reference) ):

PLACES_MAPS_API_KEY='YourAwesomeUltraSecretKey'
MAP_WIDGET_HEIGHT=480
MAP_OPTIONS={}
MARKER_OPTIONS={}

Then use it in a project:

from places.fields import PlacesField
location = PlacesField()

This enables the following API:

```python
>>> from myapp.models import ModelName
>>> poi = ModelName.objects.get(id=1)
>>> poi.position
Place('Metrocentro, Managua, Nicaragua', 52.522906, 13.41156)
>>> poi.position.place
'Metrocentro, Managua, Nicaragua'
>>> poi.position.latitude
52.522906
>>> poi.position.longitude
13.41156
```

Demo
------


TODO-LIST
--------

* [ ] Write some test ASAP!
* [ ] Support Inline Admin

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

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py

Credits
---------

Tools used in rendering this package:

* [Cookiecutter](https://github.com/audreyr/cookiecutter)
* [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)
* [jquery-geocomplete](https://github.com/ubilabs/geocomplete)

Similar Projects
------------

* [Django Location Field](https://github.com/caioariede/django-location-field)
* [Django GeoPosition](https://github.com/philippbosch/django-geoposition)