Skip to main content

Parse OSM and Overpass JSON

Project description

osm2geojson

Test package

Parse OSM and Overpass JSON with python. This library is under development!

Usage

Install this package with pip:

$ pip install osm2geojson

If you want to convert OSM xml or Overpass json/xml to Geojson you can import this lib and use one of 4 methods:

  • json2shapes(dict json_from_overpass) - to convert Overpass json to *Shape-objects
  • xml2shapes(str xml_from_osm) - to convert OSM xml or Overpass xml to *Shape-objects
  • json2geojson(dict json_from_overpass) - to convert Overpass json to Geojson
  • xml2geojson(str xml_from_osm) - to convert OSM xml or Overpass xml to Geojson

Additional parameters for all functions:

  • filter_used_refs - (default: True) defines geometry filtration strategy (will return all geometry if set as False)
  • log_level - (default: 'ERROR') controlls logging level (will print all logs if set as 'INFO'). More details here

Other handy methods:

  • overpass_call(str query) - runs query to overpass-api.de server (retries 5 times in case of error).
  • shape_to_feature(Shape shape, dict properties) - Converts Shape-object to GeoJSON with passed properties.

*Shape-object - for convinience created simple dict to save Shapely object (geometry) and OSM-properties. Structure of this object:

shape_obj = {
    'shape': Point | LineString | Polygon ...,
    'properties': {
        'type': 'relation' | 'node' ...,
        'tags': { ... },
        ...
    }
}

Examples

Convert OSM-xml to Geojson:

import codecs
import osm2geojson

with codecs.open('file.osm', 'r', encoding='utf-8') as data:
    xml = data.read()

geojson = osm2geojson.xml2geojson(xml, filter_used_refs=False, log_level='INFO')
# >> { "type": "FeatureCollection", "features": [ ... ] }

Convert OSM-json to Shape-objects:

import codecs
import osm2geojson

with codecs.open('file.json', 'r', encoding='utf-8') as data:
    json = data.read()

shapes_with_props = osm2geojson.json2shapes(json)
# >> [ { "shape": <Shapely-object>, "properties": {...} }, ... ]

Development

Clone project with submodules

$ git clone --recurse-submodules https://github.com/aspectumapp/osm2geojson.git

Setup package

$ python setup.py develop

Run tests

$ python -m unittest tests

Run single test

$ python tests/main.py TestOsm2GeoJsonMethods.test_barrier_wall

Update osm-polygon-features to last version (if you want last version)

$ ./update-osm-polygon-features.sh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osm2geojson-0.1.32.tar.gz (11.4 kB view details)

Uploaded Source

File details

Details for the file osm2geojson-0.1.32.tar.gz.

File metadata

  • Download URL: osm2geojson-0.1.32.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for osm2geojson-0.1.32.tar.gz
Algorithm Hash digest
SHA256 6916b302cc8f13dee28d3c738c611c45f5c4514b172ee62640b793f5793244cd
MD5 d28762139744daf4c10e59a64be345bf
BLAKE2b-256 8c7060662649c8e0253bb3b5395271d8d3b371c0b772698520fe98dd3d7b79df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page