gammon-im 2.0.0__py3-none-any.whl

gammon/__init__.py

@@ -0,0 +1,2 @@
+from ._main import __version__, convert, ConversionError
+__all__ = ['__version__', 'convert', 'ConversionError']

gammon/__main__.py

@@ -0,0 +1,3 @@
+import sys
+from ._main import _main
+sys.exit(_main())

gammon/__version__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version('gammon-im')
+except PackageNotFoundError:
+    __version__ = '0.0.0.dev0'

gammon/_main.py

@@ -0,0 +1,219 @@
+import lxml.etree as tree
+import sys
+import lxml.builder
+import re
+import collections
+import argparse
+from .__version__ import __version__
+
+
+class ConversionError(Exception):
+    def __init__(self, message):
+        super().__init__(message)
+
+
+E = lxml.builder.ElementMaker()
+
+ns = {'x': 'http://www.opengis.net/kml/2.2'}
+mwm = 'https://maps.me'
+mwmns = {'mwm': mwm}
+google_style_regex = re.compile(r'^#icon-(\d{4})-([0-9A-F]{6})')
+
+# noinspection SpellCheckingInspection
+style_map = {
+    'C2185B': 'placemark-red',
+    'A52714': 'placemark-red',
+    '0288D1': 'placemark-blue',
+    '673AB7': 'placemark-blue',
+    '006064': 'placemark-blue',
+    '01579B': 'placemark-blue',
+    '1A237E': 'placemark-blue',
+    '0097A7': 'placemark-blue',
+    '3949AB': 'placemark-blue',
+    '880E4F': 'placemark-purple',
+    '9C27B0': 'placemark-purple',
+    'FBC02D': 'placemark-yellow',
+    'FFD600': 'placemark-yellow',
+    'FFEA00': 'placemark-yellow',
+    'FF5252': 'placemark-pink',
+    '817717': 'placemark-brown',
+    '4E342E': 'placemark-brown',
+    'AFB42B': 'placemark-brown',
+    '795548': 'placemark-brown',
+    '424242': 'placemark-brown',
+    '000000': 'placemark-brown',
+    '757575': 'placemark-brown',
+    '097138': 'placemark-green',
+    '558B2F': 'placemark-green',
+    '7CB342': 'placemark-green',
+    '0F9D58': 'placemark-green',
+    'E65100': 'placemark-orange',
+    'F57C00': 'placemark-orange',
+    'F9A825': 'placemark-orange',
+    'BDBDBD': 'placemark-orange',
+}
+
+icon_map = {
+    '1602': 'Hotel',
+    '1507': 'Animals',
+    '1743': 'Animals',
+    '1667': 'Buddhism',
+    '1668': 'Buddhism',
+    '1669': 'Buddhism',
+    '1533': 'Building',
+    '1546': 'Building',
+    '1548': 'Building',
+    '1717': 'Building',
+    '1741': 'Building',
+    '1603': 'Building',
+    '1716': 'Building',
+    '1670': 'Christianity',
+    '1709': 'Entertainment',
+    '1540': 'Entertainment',
+    '1555': 'Exchange',
+    '1517': 'Food',
+    '1534': 'Food',
+    '1577': 'Food',
+    '1581': 'Gas',
+    '1675': 'Judaism',
+    '1624': 'Medicine',
+    '1634': 'Mountain',
+    '1636': 'Museum',
+    '1592': 'None',
+    '1899': 'None',
+    '1673': 'Islam',
+    '1720': 'Park',
+    '1644': 'Parking',
+    '1684': 'Shop',
+    '1685': 'Shop',
+    '1598': 'Sights',
+    '1521': 'Swim',
+    '1701': 'Swim',
+    '1703': 'Water',
+}
+
+
+def indent(elem, level=0):
+    i = '\n' + level * '  '
+    if len(elem):
+        if not elem.text or not elem.text.strip():
+            elem.text = i + '  '
+        if not elem.tail or not elem.tail.strip():
+            elem.tail = i
+        for elem in elem:
+            indent(elem, level + 1)
+        if not elem.tail or not elem.tail.strip():
+            elem.tail = i
+    else:
+        if level and (not elem.tail or not elem.tail.strip()):
+            elem.tail = i
+
+
+def google_to_organic_maps_icon_and_style(google_style):
+    icon, style = None, google_style
+    m = google_style_regex.match(google_style)
+    if m and m.group(1) in icon_map:
+        icon = icon_map[m.group(1)]
+    if m and m.group(2) in style_map:
+        style = '#' + style_map[m.group(2)]
+    return icon, style
+
+
+def err(*args, **kwargs):
+    print(*args, file=sys.stderr, **kwargs)
+
+
+def remove_old_styles(doc):
+    for i in doc.xpath('x:Style | x:StyleMap', namespaces=ns):
+        i.getparent().remove(i)
+
+
+def remove_lines(doc):
+    for i in doc.xpath('x:Folder/x:Placemark[x:LineString]', namespaces=ns):
+        i.getparent().remove(i)
+
+
+def remove_empty_folders(doc):
+    for i in doc.xpath('x:Folder[not(x:Placemark)]', namespaces=ns):
+        i.getparent().remove(i)
+
+
+def new_ordered_set(xs):
+    return collections.OrderedDict((x, None) for x in xs)
+
+
+def add_organic_maps_styles(doc):
+    unique_styles = new_ordered_set(style_map.values())
+    for i, name in enumerate(unique_styles):
+        ref = f'http://maps.me/placemarks/{name}.png'
+        style = E.Style(E.IconStyle(E.Icon(E.href(ref))), id=name)
+        doc.insert(i, style)
+
+
+def google_to_organic_maps_icons(doc, verbose):
+    for i in doc.xpath('x:Folder/x:Placemark/x:styleUrl', namespaces=ns):
+        google_style = i.text
+        icon, i.text = google_to_organic_maps_icon_and_style(google_style)
+        if icon is not None:
+            if icon != 'None':
+                placemark = i.getparent()
+                extended = placemark.find('x:ExtendedData', ns)
+                if extended is None:
+                    extended = tree.SubElement(placemark, 'ExtendedData', nsmap=mwmns)
+                    icon_tag = tree.SubElement(extended, f'{{{mwm}}}icon')
+                else:
+                    icon_tag = tree.SubElement(extended, f'{{{mwm}}}icon', nsmap=mwmns)
+                icon_tag.text = icon
+        elif verbose:
+            err(f'the icon from the following style is not found: {google_style}')
+
+
+def process(doc, verbose):
+    remove_old_styles(doc)
+    remove_lines(doc)
+    remove_empty_folders(doc)
+    add_organic_maps_styles(doc)
+    google_to_organic_maps_icons(doc, verbose)
+
+
+def leave_unsupported(doc):
+    for i in doc.xpath('x:Folder/x:Placemark/x:styleUrl', namespaces=ns):
+        icon, style = google_to_organic_maps_icon_and_style(i.text)
+        if icon is not None and style != i.text:
+            i.getparent().getparent().remove(i.getparent())
+
+
+def convert(input_file, output_file, verbose, only_unsupported):
+    try:
+        root = tree.parse(input_file)
+    except tree.XMLSyntaxError:
+        raise ConversionError('The document is either not in XML format or is poorly formatted')
+
+    doc = root.find('.//x:Document', ns)
+    if doc is None:
+        raise ConversionError('The "Document" tag is missing')
+
+    if not only_unsupported:
+        process(doc, verbose)
+    else:
+        leave_unsupported(doc)
+
+    indent(root.getroot())
+    string = tree.tostring(root, pretty_print=True, encoding='UTF-8', xml_declaration=True)
+    output_file.write(string)
+
+
+def _main():
+    parser = argparse.ArgumentParser(prog=__package__, description='Google My Maps to Organic Maps KML converter')
+    parser.add_argument('file', metavar='GOOGLE_KML', help='Google My Maps KML')
+    parser.add_argument('--verbose', action='store_true', help='verbose output')
+    parser.add_argument('--only-unsupported-styles', dest='only_unsupported', action='store_true',
+                        help='leave only placemarks with unsupported styles')
+    parser.add_argument('-v', '--version', action='version', version=f'%(prog)s {__version__}')
+    args = parser.parse_args()
+    try:
+        with open(args.file, 'r') as input_file:
+            convert(input_file, sys.stdout.buffer, args.verbose, args.only_unsupported)
+    except Exception as e:
+        err(e)
+        return 1

gammon_im-2.0.0.dist-info/METADATA

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: gammon-im
+Version: 2.0.0
+Summary: Google My Maps to Organic Maps KML converter
+Project-URL: Homepage, https://github.com/igrmk/gammon
+Project-URL: Website, https://gammon.im
+Author-email: igrmk <igrmkx@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: lxml
+Description-Content-Type: text/markdown
+
+Gammon — Google My Maps to Organic Maps KML converter
+=====================================================
+
+This tool adapts KML files from Google My Maps
+for use with [Organic Maps](https://organicmaps.app/) (and MAPS.ME),
+striving to maintain color and icon accuracy.
+Although Organic Maps supports fewer colors and icons,
+the tool does its best to match the original as closely as possible.
+Input on new icon mappings is appreciated.
+
+Formerly published as `mmmm`; now installed as `gammon-im` and run as `gammon` (online at
+[gammon.im](https://gammon.im)).
+If you installed the old package, migrate with `pipx uninstall mmmm && pipx install gammon-im`.
+
+Usage
+-----
+
+    gammon google-maps.kml > organic-maps.kml
+
+Or go to [Gammon](https://gammon.im) and convert your KML online.
+
+Installation
+------------
+
+    pipx install gammon-im
+
+Development
+-----------
+
+Install [uv](https://docs.astral.sh/uv/), then sync the environment and run the converter or the linter:
+
+    uv sync
+    uv run gammon google-maps.kml > organic-maps.kml
+    uv run ruff check
+

gammon_im-2.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+gammon/__init__.py,sha256=5B0G6JAz2tq7k0TyBakXC-vWgB9TgVRnVXgmW1VQWMU,113
+gammon/__main__.py,sha256=imGPIFJ1FB5eScNLGnkkF4HQpyn6Vwx7g-0HqXwFr6s,54
+gammon/__version__.py,sha256=L26xsDhKXzAEpeFGnNg-qSAuayOj9oIgQBznP-HA4kQ,166
+gammon/_main.py,sha256=NfvE1-uqszRGSTLSd3vFZSWZ7spMvS83PoA3pvFPSHY,6674
+gammon_im-2.0.0.dist-info/METADATA,sha256=1nVArUngUKKrSehxibrhzWwwOgjhcLsGI_qZhwotLJ8,1528
+gammon_im-2.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+gammon_im-2.0.0.dist-info/entry_points.txt,sha256=qsK70OnMiR_RpIh1FimzcRmb6pz-tUrF07E_TYdLrgs,46
+gammon_im-2.0.0.dist-info/licenses/LICENSE,sha256=yfHJftVrbCeDtBMmbonoxbjtCYmoWm0Hf-nJbH6Z6T4,1062
+gammon_im-2.0.0.dist-info/RECORD,,

gammon_im-2.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

gammon_im-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gammon = gammon._main:_main

gammon_im-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 igrmk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.