| Name | dj-places JSON |
| Version |
5.2.0
JSON |
| download |
| home_page | None |
| Summary | A django app for store places using Google Maps API |
| upload_time | 2023-02-03 21:04:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
django
geocomplete
google
maps
places
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# [django-places](https://pypi.org/project/dj-places/)
[](https://badge.fury.io/py/dj-places)
A Django app for store places with autocomplete function and a related map to the selected place.
## 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/reference/map)):
```python
PLACES_MAPS_API_KEY='YourAwesomeUltraSecretKey'
PLACES_MAP_WIDGET_HEIGHT=480
PLACES_MAP_OPTIONS='{"center": { "lat": 38.971584, "lng": -95.235072 }, "zoom": 10}'
PLACES_MARKER_OPTIONS='{"draggable": true}'
```
## Usage
--------
Then use it in a project:
```python
from django.db import models
from places.fields import PlacesField
class MyLocationModel(models.Model):
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
```
For using outside the Django Admin:
```html
<form method="post">
{% csrf_token %}
{{ form.as_p }}
<input type="submit" value="Save">
{{ form.media }}
</form>
```
Remember to add the `{{ form.media }}` in your template.
## Demo
------
### 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) (_no longer used in the project._)
### Similar Projects
------------
* [Django Location Field](https://github.com/caioariede/django-location-field)
* [Django GeoPosition](https://github.com/philippbosch/django-geoposition)
Raw data
{
"_id": null,
"home_page": null,
"name": "dj-places",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "django,geocomplete,google,maps,places",
"author": null,
"author_email": "Oscar Cortez <om.cortez.2010@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/97/d9a93a1173c69ef227ad208c27d172c54727eb66de7f5e5a88a65e4ec6f0/dj_places-5.2.0.tar.gz",
"platform": null,
"description": "# [django-places](https://pypi.org/project/dj-places/)\n\n[](https://badge.fury.io/py/dj-places)\n\nA Django app for store places with autocomplete function and a related map to the selected place.\n\n## Quickstart\n----------\n\nInstall `dj-places` and add it to your installed apps:\n\n```\n$ pip install dj-places\n```\n\n```\n INSTALLED_APPS = (\n \t...\n \t'places',\n \t...\n )\n```\n\nAdd the following settings and maps api key ([read more here](https://developers.google.com/maps/documentation/javascript/reference/map)):\n\n```python\nPLACES_MAPS_API_KEY='YourAwesomeUltraSecretKey'\nPLACES_MAP_WIDGET_HEIGHT=480\nPLACES_MAP_OPTIONS='{\"center\": { \"lat\": 38.971584, \"lng\": -95.235072 }, \"zoom\": 10}'\nPLACES_MARKER_OPTIONS='{\"draggable\": true}'\n```\n\n## Usage\n--------\n\nThen use it in a project:\n\n```python\nfrom django.db import models\nfrom places.fields import PlacesField\n\n\nclass MyLocationModel(models.Model):\n location = PlacesField()\n\n```\n\nThis enables the following API:\n\n```python\n >>> from myapp.models import ModelName\n >>> poi = ModelName.objects.get(id=1)\n >>> poi.position\n Place('Metrocentro, Managua, Nicaragua', 52.522906, 13.41156)\n >>> poi.position.place\n 'Metrocentro, Managua, Nicaragua'\n >>> poi.position.latitude\n 52.522906\n >>> poi.position.longitude\n 13.41156\n```\n\nFor using outside the Django Admin:\n\n```html\n<form method=\"post\">\n {% csrf_token %}\n {{ form.as_p }}\n <input type=\"submit\" value=\"Save\">\n {{ form.media }}\n</form>\n```\nRemember to add the `{{ form.media }}` in your template.\n\n## Demo\n------\n\n\n\n### Credits\n---------\n\nTools used in rendering this package:\n\n* [Cookiecutter](https://github.com/audreyr/cookiecutter)\n* [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)\n* [jquery-geocomplete](https://github.com/ubilabs/geocomplete) (_no longer used in the project._)\n\n### Similar Projects\n------------\n\n* [Django Location Field](https://github.com/caioariede/django-location-field)\n* [Django GeoPosition](https://github.com/philippbosch/django-geoposition)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A django app for store places using Google Maps API",
"version": "5.2.0",
"split_keywords": [
"django",
"geocomplete",
"google",
"maps",
"places"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "88fd0dc68c43176376811993831472c4c1426873db1b701e76b8f07229d45280",
"md5": "0478f3b1a71f8dfbf1c446a017ec3674",
"sha256": "32549ae88ac06347b14213ef11ac8561ff7b6cc609acafe99ab2dd70f575667a"
},
"downloads": -1,
"filename": "dj_places-5.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0478f3b1a71f8dfbf1c446a017ec3674",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14043,
"upload_time": "2023-02-03T21:04:48",
"upload_time_iso_8601": "2023-02-03T21:04:48.180503Z",
"url": "https://files.pythonhosted.org/packages/88/fd/0dc68c43176376811993831472c4c1426873db1b701e76b8f07229d45280/dj_places-5.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3b97d9a93a1173c69ef227ad208c27d172c54727eb66de7f5e5a88a65e4ec6f0",
"md5": "45b2e6d7c59063a074faad70575c3414",
"sha256": "81b89ed9c94ba421f7e9256adfa980fc3dbf884f2e643af689421134a636a7c2"
},
"downloads": -1,
"filename": "dj_places-5.2.0.tar.gz",
"has_sig": false,
"md5_digest": "45b2e6d7c59063a074faad70575c3414",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6469,
"upload_time": "2023-02-03T21:04:45",
"upload_time_iso_8601": "2023-02-03T21:04:45.623033Z",
"url": "https://files.pythonhosted.org/packages/3b/97/d9a93a1173c69ef227ad208c27d172c54727eb66de7f5e5a88a65e4ec6f0/dj_places-5.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-03 21:04:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "dj-places"
}
