osmexp 0.1.0__py3-none-any.whl

osmexp/__main__.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+
+import sys
+
+from .geojson import export_node, export_relation, export_way
+
+HELP = """
+Usage: osmexp [element] [id]
+
+Arguments:
+    element: The OSM element type, options: "rel", "way" or "node".
+    id:      The OSM element ID: an integer number.
+
+Output: A GeoJSON representation of the element.
+"""
+
+def main():
+
+    if len(sys.argv) != 3 or (len(sys.argv) == 2 and sys.argv[1] in ['-h', '--help']):
+        print(HELP)
+        sys.exit()
+
+    if sys.argv[1].lower() not in ['rel', 'way', 'node']:
+        print('Unknown element type, please use "rel", "way" or "node".')
+        sys.exit()
+
+    if not sys.argv[2].isdigit():
+        print('Element ID should be an integer.')
+        sys.exit()
+
+    element_type = sys.argv[1].lower()
+    element_id = sys.argv[2]
+
+    match element_type:
+        case 'node':
+            print(export_node(element_id))
+        case 'way':
+            print(export_way(element_id))
+        case 'rel':
+            print(export_relation(element_id))
+
+
+if __name__ == '__main__':
+    main()

osmexp/fetcher.py

@@ -0,0 +1,40 @@
+import itertools
+from http import HTTPStatus
+
+import requests
+from shapely import get_parts, polygonize_full
+from shapely.geometry import GeometryCollection, LineString, Point, Polygon
+
+API_URL = 'https://www.openstreetmap.org/api/0.6'
+
+
+def parse_nodes_ways(elements: list[dict]) -> tuple[list[dict], list[dict]]:
+    nodes = {e['id']: Point(e['lon'], e['lat']) for e in elements if e['type'] == 'node'}
+    ways = [LineString([nodes[n] for n in e['nodes']]) for e in elements if e['type'] == 'way']
+    return list(nodes.values()), ways
+
+
+def fetch_node(node_id: int) -> Point | None:
+    response = requests.get(f'{API_URL}/node/{node_id}.json')
+    if response.status_code != HTTPStatus.OK:
+        return None
+    return parse_nodes_ways(response.json()['elements'])[0][0]
+
+
+def fetch_way(way_id: int) -> LineString | Polygon | None:
+    response = requests.get(f'{API_URL}/way/{way_id}/full.json')
+    if response.status_code != HTTPStatus.OK:
+        return None
+    _, ways = parse_nodes_ways(response.json()['elements'])
+    way = ways[0]
+    return Polygon(way) if way.is_closed and way.is_ring else way
+
+
+def fetch_relation(relation_id: int) -> GeometryCollection | None:
+    response = requests.get(f'{API_URL}/relation/{relation_id}/full.json')
+    if response.status_code != HTTPStatus.OK:
+        return None
+    _, ways = parse_nodes_ways(response.json()['elements'])
+    cases = [get_parts(p) for p in polygonize_full(ways) if p]
+    parts = list(itertools.chain(*cases))
+    return GeometryCollection(parts)

osmexp/geojson.py

@@ -0,0 +1,45 @@
+import json
+
+from shapely import get_parts, to_geojson
+from shapely.geometry import MultiPolygon
+from shapely.geometry.base import BaseGeometry
+from shapely.geometry.polygon import orient
+
+from .fetcher import fetch_node, fetch_relation, fetch_way
+
+
+def right_hand_rule(geometry: BaseGeometry) -> BaseGeometry:
+    'Enforces the "right hand rule" as defined by the GeoJSON spec (RFC-7946, Section 3.1.6).'
+    if geometry.geom_type == 'Polygon':
+        if not geometry.exterior.is_ccw:
+            return orient(geometry, sign=1)
+        return geometry
+    if geometry.geom_type == 'MultiPolygon':
+        return MultiPolygon([right_hand_rule(p) for p in geometry.geoms])
+    return geometry
+
+
+def export_node(node_id) -> str:
+    if node := fetch_node(node_id):
+        return to_geojson(node)
+    return f'Error exporting node {node_id}.'
+
+
+def export_way(way_id) -> str:
+    if way := fetch_way(way_id):
+        return to_geojson(right_hand_rule(way))
+    return f'Error exporting way {way_id}.'
+
+
+def wrap_feature(part):
+    return {
+        'type': 'Feature',
+        'properties': {},
+        'geometry': json.loads(to_geojson(right_hand_rule(part))),
+    }
+
+
+def export_relation(relation_id) -> str:
+    if rel := fetch_relation(relation_id):
+        return json.dumps({'type': 'FeatureCollection', 'features': [wrap_feature(p) for p in get_parts(rel)]})
+    return f'Error exporting relation {relation_id}.'

osmexp-0.1.0.dist-info/LICENSE

@@ -0,0 +1,26 @@
+3-Clause BSD License
+
+Copyright (c) 2015, Ronaldo "Racum" Ferreira
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Ronaldo "Racum" Ferreira nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL RONALDO "RACUM" FERREIRA BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

osmexp-0.1.0.dist-info/METADATA

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: osmexp
+Version: 0.1.0
+Summary: OpenStreetMap GeoJSON Exporter
+Home-page: https://github.com/racum/osmexp
+Author: Ronaldo Ferreira
+Author-email: ronaldo@racum.com
+License: BSD-3-Clause
+Project-URL: Source, https://github.com/racum/osmexp
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: shapely
+
+# osmexp - OpenStreetMap GeoJSON Exporter
+
+The [OSM API](https://wiki.openstreetmap.org/wiki/API_v0.6) uses a specific format for their geometric primitive types based on nodes, ways and relations; and those unfortunately don’t translate 1:1 with [GeoJSON types](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1), thus a conversion is needed,
+
+## Installation:
+
+Make sure have at least Python 3.11, and install it with:
+
+```
+$ pip install osmexp
+```
+
+The only requirements are `Requests` and `Shapely`.
+
+## Usage
+
+For all exports, this is the format:
+
+```
+$ osmexp [element_type] [element_id]
+```
+
+Where `element_type` can be `node`, `way` or `rel` (for "relation"). And the ID is the numerical identifier used by OSM, if you don’t know how to get the OSM ID, [follow this article](https://racum.blog/articles/osm-to-geojson/#features-on-openstreetmap).
+
+The output is set to `STDOUT`, and it is recommended to be piped into a file or another command.
+
+### Exporting Nodes:
+
+```
+$ osmexp node 9589344640 > outdoor_seating.geojson
+```
+
+This returns a GeoJSON with a `Point` as a root type.
+
+### Exporting Ways:
+
+```
+$ osmexp way 398987317 > canal_grande.geojson
+```
+
+This returns a GeoJSON with a `LineString` as a root type if the the line is “open” or `Polygon` if the line is “closed”.
+
+### Exporting Relations:
+
+```
+$ osmexp rel 4817103 > venice.geojson
+```
+
+This returns a GeoJSON with a `FeatureCollection` as a root, and the internal features as `LineString` or `Polygon`, depending if they can self-close, or fail the polygon transformation by other means (self crossing, etc).
+
+## License
+
+This library is released under the **3-Clause BSD License**.
+
+**tl;dr**: *"free to use as long as you credit me"*.

osmexp-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+osmexp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+osmexp/__main__.py,sha256=RYSrs39Rr7fsQGIuGBuiRltw79Vy3F3E_qgZff1T9xE,1046
+osmexp/fetcher.py,sha256=LJ5LLUm1DaHigJGwY9IsMvwaTi4_AoJE3beL0IBRS_8,1526
+osmexp/geojson.py,sha256=MFpYErc5qchHH15YtnvT2wolmBs_LWLmy9wcyPqv3zQ,1418
+osmexp-0.1.0.dist-info/LICENSE,sha256=vY_J4si56jceKgBxnf5EENVfNVQ4vdXeb9h3BCR-3Is,1544
+osmexp-0.1.0.dist-info/METADATA,sha256=u06mp2Fnn_2HlIWftxsCmrmNe0re1-RmS3gNtGsq3Zc,2433
+osmexp-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+osmexp-0.1.0.dist-info/entry_points.txt,sha256=AGuz3edRWLmTiyA8RI1dw28Jt10QO57nguXtbRgp7Ns,48
+osmexp-0.1.0.dist-info/top_level.txt,sha256=P2nAZvg0o-tTlV4-PuQ7nBP2PcEEk3DXRq9wSyn2rQM,7
+osmexp-0.1.0.dist-info/RECORD,,

osmexp-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

osmexp-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+osmexp = osmexp.__main__:main

osmexp-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+osmexp