Google Maps widget for django-fluent-contents
Project description
fluentcms-googlemaps
A plugin for django-fluent-contents to show a Google Maps widget on a website.
This plugin is a work in progress. It’s already used in production, just know that there are two main area’s that need improval:
Use a better GeoPosition widget (e.g. by using a lightbox/popup)
Make cluster icons configurable.
Installation
First install the module, preferably in a virtual environment. It can be installed from PyPI:
pip install fluentcms-googlemaps
Backend Configuration
First make sure the project is configured for django-fluent-contents.
Then add the following settings:
INSTALLED_APPS += (
'geoposition',
'fluentcms_googlemaps',
)
GOOGLE_MAPS_API_KEY = None # Might be needed to define this.
Add the following to urls.py:
urlpatterns = [
...
url(r'^api/googlemaps/', include('fluentcms_googlemaps.urls')),
]
The database tables can be created afterwards:
./manage.py migrate
Now, the MapPlugin can be added to your PlaceholderField and PlaceholderEditorAdmin admin screens.
Frontend Configuration
Make sure that all plugin media files are exposed by django-fluent-contents:
{% load fluent_contents_tags %}
{% render_content_items_media %}
This tag should be placed at the bottom of the page, after all plugins are rendered. For more configuration options - e.g. integration with django-compressor - see the template tag documentation.
CSS Code
The stylesheet code is purposefully left out, since authors typically like to provide their own styling.
JavaScript Code
No configuration is required for the JavaScript integration.
By default, the plugin includes all required JavaScript code.
If needed, the includes resources can be changed by using the following settings:
MAP_MARKERWITHLABEL_JS = "fluentcms_googlemaps/vendor/markerwithlabel.js"
MAP_MARKERCLUSTERER_JS = "fluentcms_googlemaps/vendor/markerclusterer_compiled.js"
MAPPLUGIN_JS = "fluentcms_googlemaps/js/mapplugin.js"
MAPSEARCH_JS = "fluentcms_googlemaps/js/mapsearch.js"
FLUENTCMS_GOOGLEMAPS_JS = (
MAP_MARKERWITHLABEL_JS,
MAP_MARKERCLUSTERER_JS,
MAPPLUGIN_JS,
)
FLUENTCMS_GOOGLEMAPS_CSS = {}
If a value is defined as None, it will be excluded from the frontend media.
HTML code
If needed, the HTML code can be overwritten by redefining fluentcms_googlemaps/maps/default.html. Also, you can create additional map styles and define these in FLUENTCMS_GOOGLEMAPS_STYLES. The default is:
FLUENTCMS_GOOGLEMAPS_STYLES = (
('default', {
'title': _("Default"),
'template': "fluentcms_googlemaps/maps/default.html",
}),
('search', {
'title': _("Search field"),
'template': "fluentcms_googlemaps/maps/search.html",
'extra_js': (
MAPSEARCH_JS, # = "fluentcms_googlemaps/js/mapsearch.js" unless MAPSEARCH_JS is redefined
),
}),
)
By default, the following templates are looked up:
A explicitly defined template option in the FLUENTCMS_GOOGLEMAPS_STYLES.
A template named: fluentcms_googlemaps/maps/{style}.html.
The default; fluentcms_googlemaps/maps/default.html.
Importing data
Marker data can be imported from CSV files, and receive geocoding too. The import_markers command can be called with custom templates to map the CSV file data to marker fields. For example:
manage.py import_markers /stores.csv --title='{{Name}}' --group=1 --geocode='{{Address}} {{Zipcode}} {{City}} {{County}}' --geocoder=google --description="<p>{{Address}}<br>{{Zipcode}} {{City}}<br>{% if County == 'NL'%}The Netherlands{% else %}{{County}}{% endif %}</p>"
It’s recommended to add --dry-run first until all fields are properly filled. The markers are created in a single transaction at the end of all parsing.
Contributing
If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fluentcms-googlemaps-1.2.7.tar.gz.
File metadata
- Download URL: fluentcms-googlemaps-1.2.7.tar.gz
- Upload date:
- Size: 55.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 353bdbb60d568593337db44bf6fcca9f2c5275f02f192214f86be19c0355a3e0 |
|
| MD5 | fa6e7955b0ea4fe2a7209ea6b619de6c |
|
| BLAKE2b-256 | fe1c665825223a468e278f8d27a9389874111c30af29dccdbe97422790c39803 |
File details
Details for the file fluentcms_googlemaps-1.2.7-py2.py3-none-any.whl.
File metadata
- Download URL: fluentcms_googlemaps-1.2.7-py2.py3-none-any.whl
- Upload date:
- Size: 72.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 92105aafdd949e65ae36f9fea5cba3451cbe9e1bee99b57b66ff89a9e5044cf6 |
|
| MD5 | 839b86d56bed70b5cb3753470ddebdc0 |
|
| BLAKE2b-256 | 3504e0bb129718c27bfb3b00fd8565364afe2d86b01e9d5f6495bbe3e1b1f2a3 |
