Skip to main content

Translate the Overture maps schema to OpenStreetMap tags.

Project description

Overture to OSM

GitHub License GitHub last commit PyPI - Version Pepy Total Downlods

This Python project translates objects from the Overture maps schema to the OpenStreetMap (OSM) tagging scheme. The goal is to provide a seamless way to convert map data from Overture's format to a format that can be utilized within the OSM ecosystem. The package currently only supports Overture's places, buildings, and addresses layers. You can improve the Overture categorization that this package uses for the places layer by editing the Overture categories page on the OSM Wiki or submitting a pull request to the tags.json file.

There is also a Pydantic model for the transportation layer's segment object via overturetoosm.segments.SegmentProperties, but the conversion to OSM tags is not yet supported because of the Overture schema's complexity.

The package also allows you to use the module directly from the command line. With the overturemaps Python package installed, you can download and convert Overture data to OSM in two lines of code.

$ python -m pip install overturemaps overturetoosm
$ overturemaps download --bbox=-71.068,42.353,-71.058,42.363 \\
  -f geojson --type=place -o boston.geojson
$ python -m overturetoosm place -i boston.geojson --in-place --confidence 0.9

[!NOTE] Use of this package does not absolve you from following OSM's import guidelines.

Table of Contents

Features

  • Translate Overture map places to OSM tags.
  • Handle various map object types, including buildings and points of interest.
  • Ensure compatibility with OSM data structures and conventions.

Usage

This package is meant to work with GeoJSON files containing Overture maps data, including those produced by the overturemaps Python package.

pip install overturetoosm

You will probably for the most part be handling features from a GeoJSON or other file, but for demonstration purposes I'll define it inline:

>>> import overturetoosm
>>> overture = {
        "id": "123",
        "version": 1,
        "update_time": "2022-01-01T00:00:00Z",
        "sources": [
            {
                "property": "property1",
                "dataset": "dataset1",
                "confidence": 0.8,
            }
        ],
        "names": {
            "primary": "Primary Name",
        },
        "categories": {"main": "restaurant"},
        "confidence": 0.8,
        "addresses": [
            {
                "freeform": "123 E Main Blvd",
                "locality": "City",
                "postcode": "12345",
                "region": "CA",
                "country": "US",
            }
        ],
    }
>>> output = overturetoosm.process_place(overture)
{
        "name": "Primary Name",
        "addr:full": "123 E Main Blvd",
        "addr:city": "City",
        "addr:postcode": "12345",
        "addr:state": "CA",
        "addr:country": "US",
        "source": "dataset1 via overturetoosm",
        "amenity": "restaurant",
}

Note that the addr:street_address tag is not suitable for import into OSM, and thus will have to be parsed further. If you are working on places in the US, you can automatically parse the addr:street_address tag using the atlus package, a separate project I've worked on.

>>> import atlus
>>> atlus.get_address(output["addr:full"])[0]
{"addr:housenumber": "123", "addr:street": "East Main Boulevard"}

Docs

The documentation for our package is available online at our documentation page. We would greatly appreciate your contributions to help improve the auto-generated docs; please submit any updates or corrections via pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

See also

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

overturetoosm-1.2.0.tar.gz (513.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

overturetoosm-1.2.0-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file overturetoosm-1.2.0.tar.gz.

File metadata

  • Download URL: overturetoosm-1.2.0.tar.gz
  • Upload date:
  • Size: 513.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for overturetoosm-1.2.0.tar.gz
Algorithm Hash digest
SHA256 8161abc3676625367ee758ca870bf00ee7ff310050084e6fdc85220ebb567ad1
MD5 af435e99fac94bee0ba7ea04d89261ea
BLAKE2b-256 a57c61a0bc5eda572f2ca41b8851560d33dbdf3ada3785be560bbb0d2024c6cd

See more details on using hashes here.

File details

Details for the file overturetoosm-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: overturetoosm-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for overturetoosm-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 375ed15c011a7f8476ad03ba33041027edee9801b1e7da82ff275f5079b98c0b
MD5 dd86065d387846bee1d44d601e104b27
BLAKE2b-256 4f83de21bafce1fe44a36ce297ac383551ed53415fa40cf1a872c1bb4de7e028

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