Skip to main content

A Python library for enforcing polygon ring winding order in GeoJSON

Project description

geojson-rewind

Run tests codecov PyPI Version License Python Compatibility Code style: black

A Python library for enforcing polygon ring winding order in GeoJSON

The GeoJSON spec mandates the right hand rule:

A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.

This helps you generate compliant Polygon and MultiPolygon geometries.

Note: Co-ordinates in the input data are assumed to be WGS84 with (lon, lat) ordering, as per RFC 7946. Input with co-ordinates using any other CRS may lead to unexpected results.

Installation

pip install geojson-rewind

Usage

As a Library

Enforce RFC 7946 ring winding order (input/output is a GeoJSON string):

>>> from geojson_rewind import rewind

>>> input = """{
...      "geometry": {   "coordinates": [   [   [100, 0],
...                                             [100, 1],
...                                             [101, 1],
...                                             [101, 0],
...                                             [100, 0]]],
...                      "type": "Polygon"},
...      "properties": {"foo": "bar"},
...      "type": "Feature"}"""

>>> output = rewind(input)

>>> output
'{"geometry": {"coordinates": [[[100, 0], [101, 0], [101, 1], [100, 1], [100, 0]]], "type": "Polygon"}, "properties": {"foo": "bar"}, "type": "Feature"}'

>>> type(output)
<class 'str'>

Enforce RFC 7946 ring winding order (input/output is a python dict):

>>> from geojson_rewind import rewind

>>> input = {
...     'geometry': {   'coordinates': [   [   [100, 0],
...                                            [100, 1],
...                                            [101, 1],
...                                            [101, 0],
...                                            [100, 0]]],
...                     'type': 'Polygon'},
...     'properties': {'foo': 'bar'},
...     'type': 'Feature'}

>>> output = rewind(input)

>>> output
{'geometry': {'coordinates': [[[100, 0], [101, 0], [101, 1], [100, 1], [100, 0]]], 'type': 'Polygon'}, 'properties': {'foo': 'bar'}, 'type': 'Feature'}

>>> type(output)
<class 'dict'>

On the Console

# Enforce ring winding order on a GeoJSON file
$ rewind in.geojson > out.geojson

# fetch GeoJSON from the web and enforce ring winding order
$ curl "https://myserver.com/in.geojson" | rewind

Acknowledgements

geojson-rewind is a python port of Mapbox's javascript geojson-rewind package. Credit to Tom MacWright and contributors.

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

geojson-rewind-1.0.3.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

geojson_rewind-1.0.3-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file geojson-rewind-1.0.3.tar.gz.

File metadata

  • Download URL: geojson-rewind-1.0.3.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.10 Linux/5.4.0-109-generic

File hashes

Hashes for geojson-rewind-1.0.3.tar.gz
Algorithm Hash digest
SHA256 f9a0972992f20c863aa44f6f486dbb200ce3b95491aa92f35c51857353985d01
MD5 7b794b220df19936567fd5d946e9e33c
BLAKE2b-256 cf5376c4577b3f45a8dc8eb9b936378227a085f01ef249fffec11a2253b79b25

See more details on using hashes here.

File details

Details for the file geojson_rewind-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: geojson_rewind-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.10 Linux/5.4.0-109-generic

File hashes

Hashes for geojson_rewind-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 66d411c2ecbf8e7ad53d9fc62d92ba7a8f6fb033755eb7f9f3d822afff71b2b4
MD5 4596850f9d62df545073e725fa500fec
BLAKE2b-256 b37c318c96f9a78c1317e27165eab8ce95b8f0b6fa5ac7f7d54854b756070018

See more details on using hashes here.

Supported by

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