Fixed HTML repr on Jupyter and finished example map styles notebook

Author: rafpyprog

MANIFEST.in

@@ -1 +1,3 @@
 include requirements.txt
+include ./pymaps/styles/*.*
+include ./pymaps/templates/*.*

build/lib/pymaps/#pygmaps.py

@@ -0,0 +1,126 @@
+from operator import add
+
+from bs4 import BeautifulSoup
+from IPython.core.display import display, HTML
+from jsbeautifier import beautify
+import pandas as pd
+
+
+def info_window(values):
+    data = ''.join([f'<dt>{k}</dt><dd>{v}</dd>' for k, v in values.items()])
+    return f'<dl>{data}</dl>'
+
+
+class LatLng(str):
+    ''' A LatLng is a point in geographical coordinates: latitude and
+        longitude. '''
+    def __new__(self, lat, lng):
+        self.lat = lat
+        self.lng = lng
+        return str.__new__(self, f'{{lat: {lat}, lng: {lng}}}')
+
+
+class Marker(str):
+    ''' A marker identifies a location on a map.
+     Parameters:
+    * location (tuple or list, default None) – Latitude and Longitude of Map (Northing, Easting).
+    '''
+    def __new__(self, location=None, icon=None, title='', gmap='map', info_window=None):
+
+        self.attributes = {}
+        self.attributes['position'] = LatLng(*position)
+        self.attributes['map'] = gmap
+
+        if title != '':
+            self.attributes['title'] = f'"{title}"'
+
+        if icon is not None:
+            self.attributes['icon'] = f'"{icon}"'
+
+        self.template = self.fill_template(self.attributes)
+        self.template = self.add_info_window(info_window, self.template)
+
+        return str.__new__(self, self.template)
+
+    def fill_template(attr):
+        template = 'var marker = new google.maps.Marker({{{}}}); @infowindow'
+        args = ',\n        '.join([f'{k}: {v}' for k, v in attr.items()])
+        return template.format(args)
+
+    def add_info_window(info_window, template):
+        if info_window is not None:
+            func = f'attachInfoWindow(marker, "{info_window}");'
+            return template.replace('@infowindow', func)
+        return template.replace('@infowindow', '')
+
+    def __repr__(self):
+        return beautify(self.template)
+
+    def __str__(self):
+        return beautify(self.template)
+
+
+class Map():
+    def __init__(self, api_key, markers, map_type='roadmap', height='250px', width='100%', zoom=4, icon=None, labels=None,
+                 title='', info_windows=None, show_zoomcontrol=True, show_pegman=True):
+        self.template = open('template.html').read()
+        self.api_key = api_key
+        self.map_type = map_type
+        self.height = height
+        self.width = width
+        self.zoom = zoom
+        self.markers = markers
+        self.add_markers(self.markers, icon=icon, labels=labels, info_windows=info_windows)
+        self.title = title
+        self.show_pegman = show_pegman
+        self.show_zoomcontrol = show_zoomcontrol
+
+    def add_markers(self, markers, icon=None, labels=None, info_windows=None):
+        if isinstance(markers, pd.core.frame.DataFrame):
+            for n, pos in enumerate(markers.itertuples(index=False)):
+                label = ''
+                info = None
+                if labels is not None:
+                    label = labels[n]
+
+                if info_windows is not None:
+                    info = info_windows[n]
+
+                marker = Marker(pos, icon=icon, title=label, info_window=info)
+
+                self.template = self.template.replace('@marker', f'{marker}\n@marker')
+
+    @property
+    def center(self):
+        if isinstance(self.markers, pd.core.frame.DataFrame):
+            return LatLng(*self.markers.mean())
+        elif isinstance(self.markers[0], (float, int)):
+            center = self.markers
+        else:
+            if len(self.markers) > 1:
+                center = [sum(i) / len(self.markers)
+                          for i in [i for i in zip(*self.markers)]]
+            else:
+                center = self.markers[0]
+        return LatLng(*center)
+
+    @property
+    def html(self):
+        html = self.template.replace('@marker', '')
+        html = html.replace('@api_key', self.api_key)
+        html = html.replace('@map_height', self.height)
+        html = html.replace('@map_width', self.width)
+        html = html.replace('@map_center', self.center)
+        html = html.replace('@map_zoom', str(self.zoom))
+        html = html.replace('@map_type', f'"{self.map_type}"')
+        html = html.replace('@title', str(self.title))
+        html = html.replace('@map_showpegman', str(self.show_pegman).lower())
+        assert isinstance(self.show_zoomcontrol, bool)
+        html = html.replace('@map_showzoomcontrol', str(self.show_zoomcontrol).lower())
+        return html
+
+    def show(self):
+        return display(HTML(self.html))
+
+    def __repr__(self):
+        return BeautifulSoup(self.html, 'html.parser').prettify()

build/lib/pymaps/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.17'

build/lib/pymaps/marker.py

@@ -0,0 +1,13 @@
+import jinja2
+
+from .utils import position_to_latLng
+
+
+class Marker():
+    '''A marker identifies a location on a map. By default, a marker uses a
+    standard image. Markers can display custom images using the icon
+    parameter.'''
+    def __init__(self, position):
+        self._map = 'map'
+        self.position = position_to_latLng(position)
+        pass

build/lib/pymaps/pymaps.py

@@ -0,0 +1,75 @@
+import base64
+import json
+import os
+
+from jinja2 import Environment, FileSystemLoader
+
+from .utils import position_to_latLng
+
+
+this_dir, _ = os.path.split(__file__)
+TEMPLATE_DIR = 'templates'
+TEMPLATE_FILE = 'template.j2'
+TEMPLATE = os.path.join(this_dir, TEMPLATE_DIR, TEMPLATE_FILE)
+
+
+def render(tpl_path, context):
+    path, filename = os.path.split(tpl_path)
+    loader = FileSystemLoader(path or './')
+    env = Environment(loader=loader)
+    return env.get_template(filename).render(context)
+
+
+def load_style(stylename):
+    STYLES_DIR = os.path.join(this_dir, 'styles')
+    stylefile = os.path.join(STYLES_DIR, stylename + '.txt')
+    with open(stylefile) as f:
+        style = f.read()
+    return style
+
+
+class Map():
+    '''Create a Map with Google Maps Javascript API
+
+    Returns
+    -------
+    pyGmaps Map Object
+
+    Examples
+    --------
+    '''
+
+    def __init__(self, location=None, map_type='roadmap', style=None,
+                 width='100%',
+                 height='500px', zoom_start=10, show_pegman=True,
+                 show_zoom_control=True, disable_default_ui=False,
+                 title=None, api_key=""):
+        self.template_file = TEMPLATE
+        if not location:
+            # If location is not passed we center and zoom out.
+            self.location = position_to_latLng([0, 0])
+            self.zoom_start = 1
+        else:
+            self.location = position_to_latLng(location)
+            self.zoom_start = zoom_start
+        self.map_type = map_type
+        if style:
+            self.style = load_style(style)
+        else:
+            self.style = style
+        self.width = width
+        self.height = height
+        self.api_key = api_key
+        self.show_pegman = int(show_pegman)
+        self.show_zoom_control = int(show_zoom_control)
+        self.disable_default_ui = int(disable_default_ui)
+        self.title = title
+        self.html = render(self.template_file, self.__dict__)
+
+    def _repr_html_(self):
+        '''Displays the Map in a Jupyter notebook'''
+        HTML = ("data:text/html;charset=utf-8;base64," +
+                base64.b64encode(self.html.encode('utf8')).decode('utf8'))
+        iframe = ('<iframe src="{}" style="height:{};width:{};border:none !important">'
+                  '</iframe>')
+        return iframe.format(HTML, self.height, self.width)